{ "components": { "schemas": { "ActiveRunRead": { "description": "The one reindex run currently `queued` or `running` for an index, when there is one.", "properties": { "id": { "description": "Index run id", "title": "Id", "type": "string" }, "status": { "description": "Whether the run has been picked up by the worker yet", "enum": [ "queued", "running" ], "title": "Status", "type": "string" } }, "required": [ "id", "status" ], "title": "ActiveRunRead", "type": "object" }, "AgUiAssistantMessage": { "description": "What the agent said. Core already holds it on the thread and never sends it again.", "properties": { "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the text, when it said any", "title": "Content" }, "id": { "description": "the client's id for this message", "title": "Id", "type": "string" }, "role": { "const": "assistant", "description": "message kind", "title": "Role", "type": "string" }, "toolCalls": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AgUiToolCall" }, "type": "array" }, { "type": "null" } ], "description": "the calls it made, when it made any", "title": "Toolcalls" } }, "required": [ "id", "role" ], "title": "AgUiAssistantMessage", "type": "object" }, "AgUiClientOnlyMessage": { "description": "An activity or reasoning message: the client's own display state, never sent to a model.", "properties": { "id": { "description": "the client's id for this message", "title": "Id", "type": "string" }, "role": { "description": "message kind", "enum": [ "activity", "reasoning" ], "title": "Role", "type": "string" } }, "required": [ "id", "role" ], "title": "AgUiClientOnlyMessage", "type": "object" }, "AgUiContext": { "description": "A piece of application context the model should read this run.", "properties": { "description": { "description": "what the value is", "title": "Description", "type": "string" }, "value": { "description": "the value", "title": "Value", "type": "string" } }, "required": [ "description", "value" ], "title": "AgUiContext", "type": "object" }, "AgUiDocumentPart": { "description": "A document in a user message: taken by Core file id only.", "properties": { "source": { "$ref": "#/components/schemas/AgUiPartSource", "description": "where the document is" }, "type": { "const": "document", "description": "part kind", "title": "Type", "type": "string" } }, "required": [ "type", "source" ], "title": "AgUiDocumentPart", "type": "object" }, "AgUiForwardedProps": { "description": "The keys of `forwardedProps` Core reads; every other key is ignored.", "properties": { "agent": { "anyOf": [ { "$ref": "#/components/schemas/AgentRef" }, { "type": "null" } ], "description": "a stored agent the run is built on, as `agent` on `POST /responses`" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "catalogue model id to run against, or `agent:`, as `model` on `POST /responses`", "title": "Model" }, "tools": { "default": [], "description": "tools Core runs this turn, offered after the frontend `tools`: `{\"type\": \"tool\", \"name\"}` or `{\"type\": \"toolset\", \"name\"}`, as `tools[]` on `POST /responses` takes them, and decided by the same capability and policy; a tool the client runs is refused here", "items": { "discriminator": { "mapping": { "tool": "#/components/schemas/ToolReferenceParam", "toolset": "#/components/schemas/ToolsetToolParam" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ToolReferenceParam" }, { "$ref": "#/components/schemas/ToolsetToolParam" } ] }, "maxItems": 128, "title": "Tools", "type": "array" } }, "title": "AgUiForwardedProps", "type": "object" }, "AgUiFunctionCall": { "description": "The function a tool call names, and its arguments as JSON text.", "properties": { "arguments": { "description": "the call's arguments, JSON-encoded", "title": "Arguments", "type": "string" }, "name": { "description": "the tool's name", "title": "Name", "type": "string" } }, "required": [ "name", "arguments" ], "title": "AgUiFunctionCall", "type": "object" }, "AgUiImagePart": { "description": "An image in a user message.", "properties": { "source": { "$ref": "#/components/schemas/AgUiPartSource", "description": "where the image is" }, "type": { "const": "image", "description": "part kind", "title": "Type", "type": "string" } }, "required": [ "type", "source" ], "title": "AgUiImagePart", "type": "object" }, "AgUiInstructionMessage": { "description": "A system or developer message the application sends.", "properties": { "content": { "description": "the text", "title": "Content", "type": "string" }, "id": { "description": "the client's id for this message", "title": "Id", "type": "string" }, "role": { "description": "message kind", "enum": [ "system", "developer" ], "title": "Role", "type": "string" } }, "required": [ "id", "role", "content" ], "title": "AgUiInstructionMessage", "type": "object" }, "AgUiOtherPart": { "description": "An audio or video part: declared so it is refused by name, not by shape.", "properties": { "type": { "description": "part kind; refused by this surface", "enum": [ "audio", "video" ], "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "AgUiOtherPart", "type": "object" }, "AgUiPartSource": { "description": "Where a media part's bytes are: inline base64 data, an address, or a file a provider\nholds -- for Core, a file uploaded to `POST /files`.", "properties": { "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the media type of the bytes, such as `image/png`", "title": "Mimetype" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "who issued a `file` id: `artific-core`, or absent; any other provider is refused", "title": "Provider" }, "type": { "description": "`data` for base64 bytes, `url` for an address, `file` for a Core file id", "enum": [ "data", "url", "file" ], "title": "Type", "type": "string" }, "value": { "description": "the base64 bytes, the address, or the `file_...` id", "title": "Value", "type": "string" } }, "required": [ "type", "value" ], "title": "AgUiPartSource", "type": "object" }, "AgUiRunAgentInput": { "description": "One run of an AG-UI agent, answered by one governed turn on a Core thread.", "properties": { "context": { "default": [], "description": "application context, read by the model this run as the turn's instructions and never stored on the thread", "items": { "$ref": "#/components/schemas/AgUiContext" }, "maxItems": 64, "title": "Context", "type": "array" }, "forwardedProps": { "anyOf": [ { "$ref": "#/components/schemas/AgUiForwardedProps" }, { "type": "null" } ], "description": "names the model or the agent, and the tools Core runs; other keys are ignored" }, "messages": { "default": [], "description": "the conversation as the client holds it; only the messages after the last assistant message are new, because Core's thread already holds the rest", "items": { "discriminator": { "mapping": { "activity": "#/components/schemas/AgUiClientOnlyMessage", "assistant": "#/components/schemas/AgUiAssistantMessage", "developer": "#/components/schemas/AgUiInstructionMessage", "reasoning": "#/components/schemas/AgUiClientOnlyMessage", "system": "#/components/schemas/AgUiInstructionMessage", "tool": "#/components/schemas/AgUiToolMessage", "user": "#/components/schemas/AgUiUserMessage" }, "propertyName": "role" }, "oneOf": [ { "$ref": "#/components/schemas/AgUiUserMessage" }, { "$ref": "#/components/schemas/AgUiAssistantMessage" }, { "$ref": "#/components/schemas/AgUiToolMessage" }, { "$ref": "#/components/schemas/AgUiInstructionMessage" }, { "$ref": "#/components/schemas/AgUiClientOnlyMessage" } ] }, "maxItems": 1024, "title": "Messages", "type": "array" }, "parentRunId": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "description": "the run this one follows; echoed back", "title": "Parentrunid" }, "resume": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "description": "resuming an interrupt; refused when not empty, Core has none", "title": "Resume" }, "runId": { "description": "the client's id for this run, echoed back", "maxLength": 255, "title": "Runid", "type": "string" }, "state": { "description": "the client's shared state: a non-empty object that differs from the thread's working state replaces it before the turn runs", "title": "State" }, "threadId": { "description": "the Core thread this run continues (`thr_...`, from `POST /threads`); an unknown thread, or another person's, is refused as `POST /responses` refuses it", "title": "Threadid", "type": "string" }, "tools": { "default": [], "description": "frontend tools the model may call", "items": { "$ref": "#/components/schemas/AgUiTool" }, "maxItems": 128, "title": "Tools", "type": "array" } }, "required": [ "threadId", "runId" ], "title": "AgUiRunAgentInput", "type": "object" }, "AgUiTextPart": { "description": "A piece of text in a user or tool message.", "properties": { "text": { "description": "the text", "title": "Text", "type": "string" }, "type": { "const": "text", "description": "part kind", "title": "Type", "type": "string" } }, "required": [ "type", "text" ], "title": "AgUiTextPart", "type": "object" }, "AgUiTool": { "description": "A frontend tool: the model may call it, the run ends with the call, and the client runs\nit and sends the result in the next run's `messages`.", "properties": { "description": { "default": "", "description": "what the tool does, for the model", "title": "Description", "type": "string" }, "name": { "description": "the tool's name", "title": "Name", "type": "string" }, "parameters": { "additionalProperties": true, "default": { "properties": {}, "type": "object" }, "description": "JSON Schema for the tool's arguments", "title": "Parameters", "type": "object" } }, "required": [ "name" ], "title": "AgUiTool", "type": "object" }, "AgUiToolCall": { "description": "One call an assistant message made.", "properties": { "function": { "$ref": "#/components/schemas/AgUiFunctionCall", "description": "what was called, with what" }, "id": { "description": "the call's id, which a `tool` message answers", "title": "Id", "type": "string" }, "type": { "const": "function", "default": "function", "description": "call kind", "title": "Type", "type": "string" } }, "required": [ "id", "function" ], "title": "AgUiToolCall", "type": "object" }, "AgUiToolMessage": { "description": "The result of a frontend tool the client ran.", "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "discriminator": { "mapping": { "audio": "#/components/schemas/AgUiOtherPart", "document": "#/components/schemas/AgUiDocumentPart", "image": "#/components/schemas/AgUiImagePart", "text": "#/components/schemas/AgUiTextPart", "video": "#/components/schemas/AgUiOtherPart" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AgUiTextPart" }, { "$ref": "#/components/schemas/AgUiImagePart" }, { "$ref": "#/components/schemas/AgUiDocumentPart" }, { "$ref": "#/components/schemas/AgUiOtherPart" } ] }, "type": "array" } ], "description": "the result, as text or text parts", "title": "Content" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the tool's own error, when it failed", "title": "Error" }, "id": { "description": "the client's id for this message", "title": "Id", "type": "string" }, "role": { "const": "tool", "description": "message kind", "title": "Role", "type": "string" }, "toolCallId": { "description": "the call this result answers", "title": "Toolcallid", "type": "string" } }, "required": [ "id", "role", "toolCallId", "content" ], "title": "AgUiToolMessage", "type": "object" }, "AgUiUserMessage": { "description": "What the person said.", "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "discriminator": { "mapping": { "audio": "#/components/schemas/AgUiOtherPart", "document": "#/components/schemas/AgUiDocumentPart", "image": "#/components/schemas/AgUiImagePart", "text": "#/components/schemas/AgUiTextPart", "video": "#/components/schemas/AgUiOtherPart" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AgUiTextPart" }, { "$ref": "#/components/schemas/AgUiImagePart" }, { "$ref": "#/components/schemas/AgUiDocumentPart" }, { "$ref": "#/components/schemas/AgUiOtherPart" } ] }, "type": "array" } ], "description": "the text, or its parts", "title": "Content" }, "id": { "description": "the client's id for this message; Core keeps a new message's id, at most 255 characters, so the same message sent again after a failed run is not stored twice", "title": "Id", "type": "string" }, "role": { "const": "user", "description": "message kind", "title": "Role", "type": "string" } }, "required": [ "id", "role", "content" ], "title": "AgUiUserMessage", "type": "object" }, "AgentAsToolParam": { "additionalProperties": false, "description": "A stored agent, offered to this turn as one tool (`agent__`): the model calls it with\nthe agent's prompt variables and an `input`, and Core runs one nested turn built from the\nagent's definition under the calling key (`docs/architecture/agents.md`, \"An agent as a\ntool\"). The nested turn offers no agent tool of its own: depth is one.\n\n`name` rather than a field called `agent`, so every `tools[]` entry Core runs carries the same\ntwo keys -- a type and a name -- and a reader of a stored list reads all four kinds alike.", "properties": { "name": { "description": "the agent's name or `agt_` id", "maxLength": 64, "title": "Name", "type": "string" }, "type": { "const": "agent", "default": "agent", "description": "tool param kind", "title": "Type", "type": "string" }, "version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "pinned agent version; its latest when unset, and pinned to the version this turn resolved when the response is stored", "title": "Version" } }, "required": [ "name" ], "title": "AgentAsToolParam", "type": "object" }, "AgentBackground": { "additionalProperties": false, "description": "Whether a turn that offers this agent as a tool may start it as a task, and for how long\n(`docs/architecture/tasks.md#which-tools`). There is no `retry_safe`: an agent task is a\nrun, which resumes from its last committed round.", "properties": { "max_seconds": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "how long a task running this agent may take, in seconds; null uses the deployment's task_max_seconds, and a larger value is cut to it", "title": "Max Seconds" }, "mode": { "default": "never", "description": "`never` keeps every call synchronous; `allowed` lets the model start the agent in the background as well as call it; `always` makes a direct call start it in the background wherever the turn can hold a task", "enum": [ "never", "allowed", "always" ], "title": "Mode", "type": "string" } }, "title": "AgentBackground", "type": "object" }, "AgentCopyCreate": { "additionalProperties": false, "description": "Body of `POST /agents/{agent_id}/copy` and its twin: creates a new agent from one published\nversion of another. Its own model, since it carries a name and a version rather than a\ndefinition (`docs/architecture/versions-and-drafts.md#copying`).", "properties": { "name": { "description": "The new object's name, unique within the organisation and held to the kind's own naming rule, exactly as a create's name is", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "title": "Name", "type": "string" }, "version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "The published version to copy; absent copies the latest published version. A draft is never copied, and naming one answers as a version that was never written does", "title": "Version" } }, "required": [ "name" ], "title": "AgentCopyCreate", "type": "object" }, "AgentCreate": { "additionalProperties": false, "description": "Body of `POST /agents`: creates the agent and its first version (1) together.", "properties": { "background": { "anyOf": [ { "$ref": "#/components/schemas/AgentBackground" }, { "type": "null" } ], "description": "whether a turn offering this agent as a tool may start it as a task that outlives the turn; null is `never`" }, "blocked_reply": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "the standard reply, at most 1000 characters, a turn answers with when an input check fails: one assistant message carrying it as a `refusal`. Required when an input check blocks", "title": "Blocked Reply" }, "compaction": { "anyOf": [ { "$ref": "#/components/schemas/CompactionConfig" }, { "type": "null" } ], "description": "how much of a thread a turn this agent runs reads. Unlike every other field here it is not a field of the request at all -- `POST /responses` has none -- but the calling key's own `compaction` configuration, which this replaces whole for the turn. Null leaves the key's alone, and so does any value when the calling key does not hold the `compaction` capability: an agent never reaches past the key that called it" }, "description": { "default": "", "description": "What this agent is for", "maxLength": 1024, "title": "Description", "type": "string" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/InstallValue" }, "description": "a typed value for every `{{ $name }}` in `instructions`, by name: `{type, value, allowed, description}`, a `string`, `number` or `enum` as a shared bundle's parameters are. Its text is filled in before the instruction joins a turn, as the author's own text. Every `{{ $name }}` needs a value and every value must be used, and a value may not contain `{{` or `}}`. A copy a publication installed carries the installer's values already written into its instructions, and `{}` here", "maxProperties": 64, "title": "Install Values", "type": "object" }, "instructions": { "anyOf": [ { "maxLength": 262144, "type": "string" }, { "type": "null" } ], "description": "a standing developer instruction this agent contributes, at most 262144 characters", "title": "Instructions" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "the organisation's classification of the agent, as label -> value, which the rules over `agent` read. It belongs to the agent rather than to one version, so a new version that names none leaves it as it is and {} clears it; an agent has no other update route", "title": "Labels" }, "live_checks": { "description": "the rules a turn of this agent is held to while it happens, at most 16: on the caller's message before any model call (`input`) or on the answer (`output`). A failed input check answers with `blocked_reply` and calls no model; a failed output check withholds the answer and ends the turn `incomplete` with `content_filter`. Names are unique within the list", "items": { "$ref": "#/components/schemas/LiveCheck" }, "maxItems": 16, "title": "Live Checks", "type": "array" }, "max_output_tokens": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "ceiling on generated output tokens", "title": "Max Output Tokens" }, "max_tool_rounds": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "ceiling on tool rounds for a turn this agent runs", "title": "Max Tool Rounds" }, "memory_injection": { "anyOf": [ { "$ref": "#/components/schemas/MemoryInjectionConfig" }, { "type": "null" } ], "description": "which memory store a turn this agent runs is handed records from, in the key's own `memory.injection` shape. It replaces the calling key's block whole for the turn, `enabled: false` included, which hands nothing; null leaves the key's alone, and so does any value when the calling key does not hold `memory`" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "an opaque document a caller attaches to the agent, at most 16 KiB serialised: stored, returned and never read by Core. It belongs to the agent rather than to one version, so a new version that names none leaves it as it is and {} clears it; an agent has no other update route", "title": "Metadata" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "catalogue model id a turn runs against when the request names none", "title": "Model" }, "name": { "description": "Unique name within the tenant, used to name it", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "title": "Name", "type": "string" }, "prompt": { "anyOf": [ { "$ref": "#/components/schemas/AgentPromptRef" }, { "type": "null" } ], "description": "a stored prompt version this agent pins and renders as input" }, "reasoning": { "anyOf": [ { "$ref": "#/components/schemas/ReasoningParam" }, { "type": "null" } ], "description": "what a turn this agent runs asks of the model's own thinking: how hard to think, and whether to return a readable summary of it" }, "recover_attempts": { "anyOf": [ { "maximum": 3.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "how often a turn asks the model again for an answer a check with `recover` failed, 1 to 3, 2 when unset or null. Each attempt is a model round the turn's key pays for; when they are spent the answer is withheld", "title": "Recover Attempts" }, "routing_config_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "the routing configuration a turn this agent runs falls over along, one of this organisation's with a published version; it replaces the calling key's whole for the turn, and a request's own beats it. Null leaves the key's, and so does any value when the calling key's `fallback_routing_enabled` is off", "title": "Routing Config Id" }, "skills": { "description": "skill names or `skill_` ids this agent offers, each pinned to a version: `name@3` pins version 3, and an entry naming none is written pinned to the skill's latest version at that moment; a request's own are added", "items": { "type": "string" }, "maxItems": 32, "title": "Skills", "type": "array" }, "temperature": { "anyOf": [ { "maximum": 2.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "sampling temperature", "title": "Temperature" }, "text": { "anyOf": [ { "$ref": "#/components/schemas/TextFormat" }, { "type": "null" } ], "description": "the required output text format" }, "tool_approval": { "anyOf": [ { "$ref": "#/components/schemas/ToolApprovalOption" }, { "type": "null" } ], "description": "which tools a run of this agent parks for a person's approval, by mode, in the request's own `tool_approval` shape. A request can only make it stricter, never looser, and the shorter wait runs. An agent carrying it runs only in the background; null asks nothing" }, "tool_choice": { "anyOf": [ { "enum": [ "auto", "none", "required" ], "type": "string" }, { "type": "null" } ], "description": "how the model may use the offered tools", "title": "Tool Choice" }, "tool_search": { "anyOf": [ { "$ref": "#/components/schemas/ToolSearchParam" }, { "type": "null" } ], "description": "whether a turn this agent runs offers its tools directly or behind the tool router; a request's own `tool_search` wins over it, and null leaves the choice to the request and the key" }, "tools": { "description": "`tool`, `toolset` and `agent` params this agent offers; a request's own are added", "items": { "discriminator": { "mapping": { "agent": "#/components/schemas/AgentAsToolParam", "tool": "#/components/schemas/ToolReferenceParam", "toolset": "#/components/schemas/ToolsetToolParam", "workflow": "#/components/schemas/WorkflowToolParam" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ToolReferenceParam" }, { "$ref": "#/components/schemas/ToolsetToolParam" }, { "$ref": "#/components/schemas/AgentAsToolParam" }, { "$ref": "#/components/schemas/WorkflowToolParam" } ] }, "maxItems": 64, "title": "Tools", "type": "array" }, "working_state_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "a JSON Schema (Draft 2020-12) the working state of a thread is held to on a turn this agent runs, and on a write to a thread whose last turn ran it: a write that does not fit is refused, naming the first failing path. Checked at save by the same bounded validator a datastore's schema is (RE2 patterns, no remote `$ref`); null takes any JSON object", "title": "Working State Schema" } }, "required": [ "name" ], "title": "AgentCreate", "type": "object" }, "AgentLink": { "description": "One agent a suite measures, as a reader wants it: the id to follow and the name to show.", "properties": { "id": { "description": "Agent id", "title": "Id", "type": "string" }, "name": { "description": "The agent's name", "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "AgentLink", "type": "object" }, "AgentNote": { "description": "The stored agent this call's turn was built on, and which of the caller's own values it\nran without: otherwise invisible to a reviewer of the call, who sees only the agent's value\nin the request the vendor received, as `CompactionNote`'s `key_capability_missing` is\n(`docs/architecture/agents.md` \"The effective request\").", "properties": { "id": { "description": "the agent's id", "title": "Id", "type": "string" }, "name": { "description": "the agent's name", "title": "Name", "type": "string" }, "overridden": { "description": "the request fields this turn ran on the agent's value of, the caller's differing value dropped; empty when nothing was dropped", "items": { "type": "string" }, "title": "Overridden", "type": "array" }, "unsaved": { "default": false, "description": "whether a try ran an unsaved version", "title": "Unsaved", "type": "boolean" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "the agent version this turn ran; null if unsaved", "title": "Version" } }, "required": [ "id", "name", "version" ], "title": "AgentNote", "type": "object" }, "AgentPromptRead": { "description": "The prompt an agent version pins, as the API returns it: the prompt's own id and name\nbeside the pinned version number, so a reader never has to resolve a version id itself.", "properties": { "id": { "description": "Prompt id", "title": "Id", "type": "string" }, "name": { "description": "The prompt's name", "title": "Name", "type": "string" }, "version": { "description": "The pinned version number", "title": "Version", "type": "integer" } }, "required": [ "id", "name", "version" ], "title": "AgentPromptRead", "type": "object" }, "AgentPromptRef": { "additionalProperties": false, "description": "The prompt version an agent version pins.", "properties": { "id": { "description": "the prompt's name or `prm_` id", "title": "Id", "type": "string" }, "version": { "description": "the prompt version to pin; required, because a stored definition that floated would change what the agent does without a new version of the agent", "minimum": 1.0, "title": "Version", "type": "integer" } }, "required": [ "id", "version" ], "title": "AgentPromptRef", "type": "object" }, "AgentRead": { "description": "An agent, as the API returns it: its identity plus its latest version in full -- never just\na version number, so a caller reading one agent always sees what it currently does.", "properties": { "cover": { "anyOf": [ { "$ref": "#/components/schemas/CoverRead" }, { "type": "null" } ], "description": "The picture this organisation put on this agent, or null when it has none; the image itself is read from its own `.../cover` route" }, "created_at": { "description": "When the agent was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created the agent: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "description": { "description": "What this agent is for", "title": "Description", "type": "string" }, "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "id": { "description": "Agent id", "title": "Id", "type": "string" }, "labels": { "default": {}, "description": "The organisation's classification of this agent, as label -> value", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "latest_version": { "$ref": "#/components/schemas/AgentVersionRead", "description": "The highest published version; on the management twin, the newest draft while the agent has no published version" }, "metadata": { "additionalProperties": true, "default": {}, "description": "The opaque document attached to this agent; {} when none was set", "title": "Metadata", "type": "object" }, "name": { "description": "Unique name within the tenant, used to name it on a request", "title": "Name", "type": "string" }, "object": { "const": "agent", "default": "agent", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/OriginRead" }, { "type": "null" } ], "description": "The subscription that installed this agent, and the publication it came from; null for an agent this organisation wrote itself" }, "updated_at": { "description": "When the agent last gained a new version", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "name", "description", "latest_version", "created_by", "created_at", "updated_at" ], "title": "AgentRead", "type": "object" }, "AgentRef": { "additionalProperties": false, "description": "A stored agent whose definition this turn is built on.\n\n`version` floats to the agent's latest when unset, exactly as a prompt reference does;\n`variables` fills in the prompt that agent version pins, which is the only thing a caller can\nstill supply for it (`docs/architecture/agents.md`).", "properties": { "id": { "description": "the agent's name or agt_ id", "title": "Id", "type": "string" }, "variables": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "default": {}, "description": "values substituted into the prompt the agent version pins, held to its `input_schema` as `prompt.variables` is", "title": "Variables", "type": "object" }, "version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "pinned agent version; latest when unset", "title": "Version" } }, "required": [ "id" ], "title": "AgentRef", "type": "object" }, "AgentVersionCreate": { "additionalProperties": false, "description": "Body of `POST /agents/{agent_id}/versions`: adds a new version to an existing agent.", "properties": { "background": { "anyOf": [ { "$ref": "#/components/schemas/AgentBackground" }, { "type": "null" } ], "description": "whether a turn offering this agent as a tool may start it as a task that outlives the turn; null is `never`" }, "blocked_reply": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "the standard reply, at most 1000 characters, a turn answers with when an input check fails: one assistant message carrying it as a `refusal`. Required when an input check blocks", "title": "Blocked Reply" }, "compaction": { "anyOf": [ { "$ref": "#/components/schemas/CompactionConfig" }, { "type": "null" } ], "description": "how much of a thread a turn this agent runs reads. Unlike every other field here it is not a field of the request at all -- `POST /responses` has none -- but the calling key's own `compaction` configuration, which this replaces whole for the turn. Null leaves the key's alone, and so does any value when the calling key does not hold the `compaction` capability: an agent never reaches past the key that called it" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/InstallValue" }, "description": "a typed value for every `{{ $name }}` in `instructions`, by name: `{type, value, allowed, description}`, a `string`, `number` or `enum` as a shared bundle's parameters are. Its text is filled in before the instruction joins a turn, as the author's own text. Every `{{ $name }}` needs a value and every value must be used, and a value may not contain `{{` or `}}`. A copy a publication installed carries the installer's values already written into its instructions, and `{}` here", "maxProperties": 64, "title": "Install Values", "type": "object" }, "instructions": { "anyOf": [ { "maxLength": 262144, "type": "string" }, { "type": "null" } ], "description": "a standing developer instruction this agent contributes, at most 262144 characters", "title": "Instructions" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "the organisation's classification of the agent, as label -> value, which the rules over `agent` read. It belongs to the agent rather than to one version, so a new version that names none leaves it as it is and {} clears it; an agent has no other update route", "title": "Labels" }, "live_checks": { "description": "the rules a turn of this agent is held to while it happens, at most 16: on the caller's message before any model call (`input`) or on the answer (`output`). A failed input check answers with `blocked_reply` and calls no model; a failed output check withholds the answer and ends the turn `incomplete` with `content_filter`. Names are unique within the list", "items": { "$ref": "#/components/schemas/LiveCheck" }, "maxItems": 16, "title": "Live Checks", "type": "array" }, "max_output_tokens": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "ceiling on generated output tokens", "title": "Max Output Tokens" }, "max_tool_rounds": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "ceiling on tool rounds for a turn this agent runs", "title": "Max Tool Rounds" }, "memory_injection": { "anyOf": [ { "$ref": "#/components/schemas/MemoryInjectionConfig" }, { "type": "null" } ], "description": "which memory store a turn this agent runs is handed records from, in the key's own `memory.injection` shape. It replaces the calling key's block whole for the turn, `enabled: false` included, which hands nothing; null leaves the key's alone, and so does any value when the calling key does not hold `memory`" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "an opaque document a caller attaches to the agent, at most 16 KiB serialised: stored, returned and never read by Core. It belongs to the agent rather than to one version, so a new version that names none leaves it as it is and {} clears it; an agent has no other update route", "title": "Metadata" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "catalogue model id a turn runs against when the request names none", "title": "Model" }, "prompt": { "anyOf": [ { "$ref": "#/components/schemas/AgentPromptRef" }, { "type": "null" } ], "description": "a stored prompt version this agent pins and renders as input" }, "reasoning": { "anyOf": [ { "$ref": "#/components/schemas/ReasoningParam" }, { "type": "null" } ], "description": "what a turn this agent runs asks of the model's own thinking: how hard to think, and whether to return a readable summary of it" }, "recover_attempts": { "anyOf": [ { "maximum": 3.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "how often a turn asks the model again for an answer a check with `recover` failed, 1 to 3, 2 when unset or null. Each attempt is a model round the turn's key pays for; when they are spent the answer is withheld", "title": "Recover Attempts" }, "routing_config_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "the routing configuration a turn this agent runs falls over along, one of this organisation's with a published version; it replaces the calling key's whole for the turn, and a request's own beats it. Null leaves the key's, and so does any value when the calling key's `fallback_routing_enabled` is off", "title": "Routing Config Id" }, "skills": { "description": "skill names or `skill_` ids this agent offers, each pinned to a version: `name@3` pins version 3, and an entry naming none is written pinned to the skill's latest version at that moment; a request's own are added", "items": { "type": "string" }, "maxItems": 32, "title": "Skills", "type": "array" }, "temperature": { "anyOf": [ { "maximum": 2.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "sampling temperature", "title": "Temperature" }, "text": { "anyOf": [ { "$ref": "#/components/schemas/TextFormat" }, { "type": "null" } ], "description": "the required output text format" }, "tool_approval": { "anyOf": [ { "$ref": "#/components/schemas/ToolApprovalOption" }, { "type": "null" } ], "description": "which tools a run of this agent parks for a person's approval, by mode, in the request's own `tool_approval` shape. A request can only make it stricter, never looser, and the shorter wait runs. An agent carrying it runs only in the background; null asks nothing" }, "tool_choice": { "anyOf": [ { "enum": [ "auto", "none", "required" ], "type": "string" }, { "type": "null" } ], "description": "how the model may use the offered tools", "title": "Tool Choice" }, "tool_search": { "anyOf": [ { "$ref": "#/components/schemas/ToolSearchParam" }, { "type": "null" } ], "description": "whether a turn this agent runs offers its tools directly or behind the tool router; a request's own `tool_search` wins over it, and null leaves the choice to the request and the key" }, "tools": { "description": "`tool`, `toolset` and `agent` params this agent offers; a request's own are added", "items": { "discriminator": { "mapping": { "agent": "#/components/schemas/AgentAsToolParam", "tool": "#/components/schemas/ToolReferenceParam", "toolset": "#/components/schemas/ToolsetToolParam", "workflow": "#/components/schemas/WorkflowToolParam" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ToolReferenceParam" }, { "$ref": "#/components/schemas/ToolsetToolParam" }, { "$ref": "#/components/schemas/AgentAsToolParam" }, { "$ref": "#/components/schemas/WorkflowToolParam" } ] }, "maxItems": 64, "title": "Tools", "type": "array" }, "working_state_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "a JSON Schema (Draft 2020-12) the working state of a thread is held to on a turn this agent runs, and on a write to a thread whose last turn ran it: a write that does not fit is refused, naming the first failing path. Checked at save by the same bounded validator a datastore's schema is (RE2 patterns, no remote `$ref`); null takes any JSON object", "title": "Working State Schema" } }, "title": "AgentVersionCreate", "type": "object" }, "AgentVersionRead": { "description": "One immutable agent version, as the API returns it.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "agent_id": { "description": "Owning agent id", "title": "Agent Id", "type": "string" }, "background": { "anyOf": [ { "$ref": "#/components/schemas/AgentBackground" }, { "type": "null" } ], "description": "Whether a turn offering this agent as a tool may start it as a task, and for how long, or null" }, "blocked_reply": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The standard reply a failed input check answers with, or null -- and null too on a sealed version", "title": "Blocked Reply" }, "compaction": { "anyOf": [ { "$ref": "#/components/schemas/CompactionConfig" }, { "type": "null" } ], "description": "How much of a thread a turn this agent runs reads, replacing the calling key's own configuration for that turn, or null" }, "created_at": { "description": "When this version was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created the version: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "id": { "description": "Agent version id", "title": "Id", "type": "string" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/InstallValue" }, "description": "A typed value for every `{{ $name }}` in the instructions, whose text is filled in before the instruction joins a turn; `{}` on a copy a publication installed, and on a sealed one", "title": "Install Values", "type": "object" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The standing developer instruction, or null -- and null too when the publication that shared this agent withholds its content ('sealed'), which a turn still runs unchanged", "title": "Instructions" }, "live_checks": { "description": "The rules a turn of this version is held to while it happens; [] for none, and [] too when the publication that shared this agent withholds its content ('sealed'), which a turn still holds itself to", "items": { "$ref": "#/components/schemas/LiveCheck" }, "title": "Live Checks", "type": "array" }, "max_output_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Ceiling on generated output tokens, or null", "title": "Max Output Tokens" }, "max_tool_rounds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Ceiling on tool rounds, or null", "title": "Max Tool Rounds" }, "memory_injection": { "anyOf": [ { "$ref": "#/components/schemas/MemoryInjectionConfig" }, { "type": "null" } ], "description": "Which memory store a turn this agent runs is handed records from, replacing the calling key's own `memory.injection` for that turn, or null" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Catalogue model id, or null when the request supplies it", "title": "Model" }, "object": { "const": "agent.version", "default": "agent.version", "description": "The object's type", "title": "Object", "type": "string" }, "prompt": { "anyOf": [ { "$ref": "#/components/schemas/AgentPromptRead" }, { "type": "null" } ], "description": "The prompt version this agent pins, or null" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "reasoning": { "anyOf": [ { "$ref": "#/components/schemas/ReasoningParam" }, { "type": "null" } ], "description": "What a turn this agent runs asks of the model's thinking, or null" }, "recover_attempts": { "description": "how often a turn asks the model again for an answer a check with `recover` failed, 1 to 3, 2 when unset or null. Each attempt is a model round the turn's key pays for; when they are spent the answer is withheld", "title": "Recover Attempts", "type": "integer" }, "routing_config_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The routing configuration a turn this agent runs falls over along, replacing the calling key's for that turn, or null", "title": "Routing Config Id" }, "sealed": { "default": false, "description": "Whether this version was installed under sealed terms, so its content is withheld here for good -- whatever a later version of the same copy says, and after a fork. A version this organisation wrote itself is never sealed", "title": "Sealed", "type": "boolean" }, "skills": { "description": "Skill names or ids this agent offers", "items": { "type": "string" }, "title": "Skills", "type": "array" }, "state": { "default": "published", "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "temperature": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Sampling temperature, or null", "title": "Temperature" }, "text": { "anyOf": [ { "$ref": "#/components/schemas/TextFormat" }, { "type": "null" } ], "description": "The required output text format, or null" }, "tool_approval": { "anyOf": [ { "$ref": "#/components/schemas/ToolApprovalOption" }, { "type": "null" } ], "description": "Which tools a run of this agent parks for a person's approval, by mode, or null" }, "tool_choice": { "anyOf": [ { "enum": [ "auto", "none", "required" ], "type": "string" }, { "type": "null" } ], "description": "How the model may use the offered tools", "title": "Tool Choice" }, "tool_search": { "anyOf": [ { "$ref": "#/components/schemas/ToolSearchParam" }, { "type": "null" } ], "description": "Whether a turn this agent runs offers its tools directly or behind the tool router, or null" }, "tools": { "description": "`tool`, `toolset` and `agent` params this agent offers", "items": { "discriminator": { "mapping": { "agent": "#/components/schemas/AgentAsToolParam", "tool": "#/components/schemas/ToolReferenceParam", "toolset": "#/components/schemas/ToolsetToolParam", "workflow": "#/components/schemas/WorkflowToolParam" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ToolReferenceParam" }, { "$ref": "#/components/schemas/ToolsetToolParam" }, { "$ref": "#/components/schemas/AgentAsToolParam" }, { "$ref": "#/components/schemas/WorkflowToolParam" } ] }, "title": "Tools", "type": "array" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" }, "working_state_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The JSON Schema a thread's working state is held to on a turn of this version, or null -- and null too when the publication that shared this agent withholds its content ('sealed'), which a turn still holds the state to", "title": "Working State Schema" } }, "required": [ "id", "agent_id", "version", "model", "instructions", "prompt", "skills", "tools", "tool_choice", "max_tool_rounds", "temperature", "max_output_tokens", "text", "reasoning", "compaction", "background", "recover_attempts", "created_by", "acted_for", "created_at" ], "title": "AgentVersionRead", "type": "object" }, "AgentsConfig": { "additionalProperties": false, "description": "The `agents` capability: stored, versioned combinations a request names instead of writing\nthem out. No configuration, and no dependency on another capability: an agent without a prompt\nor tools is a model and an instruction, and each thing a version names is checked under its\nown capability when the turn resolves it (`docs/architecture/agents.md`).", "properties": {}, "title": "AgentsConfig", "type": "object" }, "AllowedHostCreate": { "additionalProperties": false, "description": "One host to add to an organisation's allowed hosts.", "properties": { "host": { "description": "An exact hostname ('api.example.com') or '*.' plus a hostname ('*.example.com', which matches every subdomain and not the apex itself; '*.nl' permits a whole top-level domain): lowercase letters, digits, dots and hyphens only, no scheme, port or path", "maxLength": 200, "minLength": 1, "title": "Host", "type": "string" } }, "required": [ "host" ], "title": "AllowedHostCreate", "type": "object" }, "AllowedHostRead": { "additionalProperties": false, "description": "One host an organisation allows, and whether the deployment blocks it anyway.", "properties": { "blocked": { "description": "Whether the deployment's block list refuses this entry for every organisation: an exact host that is blocked, is itself a loopback, link-local, metadata or private address, or only names something inside a network (`localhost`, a single label, `.svc`, `.local`, `.internal`, a legacy address spelling such as `2130706433`), or a wildcard every host under which is blocked. A blocked host is refused although the organisation allows it; a name that resolves to such an address is refused when it is called", "title": "Blocked", "type": "boolean" }, "host": { "description": "The hostname or '*.' wildcard, as a rule names it", "title": "Host", "type": "string" } }, "required": [ "host", "blocked" ], "title": "AllowedHostRead", "type": "object" }, "AllowedHostsRead": { "description": "An organisation's allowed hosts, as every allowed-hosts route answers them.\n\nThe whole list rather than a page: it is a view over one document, which holds at most 2000\nnames, not a table that grows.", "properties": { "everywhere": { "description": "Whether a rule permits every host: a `permit` over `egress_host` that names none. Only the deployment's block list and the network guard then stand between this organisation and a destination; it is written and removed through the policy document", "title": "Everywhere", "type": "boolean" }, "hosts": { "description": "Every host a `permit` over `egress_host` of the organisation's policy document names, once each, in the order the rules name them", "items": { "$ref": "#/components/schemas/AllowedHostRead" }, "title": "Hosts", "type": "array" }, "object": { "const": "allowed_hosts", "default": "allowed_hosts", "description": "The object's type", "title": "Object", "type": "string" } }, "required": [ "everywhere" ], "title": "AllowedHostsRead", "type": "object" }, "AnalysisRead": { "description": "One analysis: when it ran, the window it read, and what each check did.", "properties": { "checks": { "additionalProperties": { "additionalProperties": true, "type": "object" }, "description": "Per check run, its outcome and counts: names and numbers only. 'not_permitted' counts, by refusal code, the findings not written as proposals because applying their change would have been refused when the analysis ran", "title": "Checks", "type": "object" }, "created_at": { "description": "When it was queued", "format": "date-time", "title": "Created At", "type": "string" }, "due_at": { "description": "The instant it is the analysis of", "format": "date-time", "title": "Due At", "type": "string" }, "finished_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When it finished", "title": "Finished At" }, "id": { "description": "Analysis id", "title": "Id", "type": "string" }, "model_calls": { "description": "Model calls it made", "title": "Model Calls", "type": "integer" }, "object": { "const": "improvement_analysis", "default": "improvement_analysis", "description": "The object's type", "title": "Object", "type": "string" }, "proposals": { "description": "Proposals it wrote or refreshed", "title": "Proposals", "type": "integer" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why it ended without running a check: 'not_enabled' when the organisation's settings or ceiling no longer allowed it, 'cap_exceeded' when its month was spent, 'already_running' when another analysis was under way; null otherwise", "title": "Reason" }, "requested_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Key id, or operator:, that asked for it; null for the clock", "title": "Requested By" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When it started running", "title": "Started At" }, "status": { "description": "Where the analysis stands", "enum": [ "queued", "running", "completed", "partial", "cancelled", "interrupted" ], "title": "Status", "type": "string" }, "trigger": { "description": "'clock' for the settings' own clock, 'manual' for a run asked for", "enum": [ "clock", "manual" ], "title": "Trigger", "type": "string" }, "window_end": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "End of the window it read", "title": "Window End" }, "window_start": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Start of the window it read", "title": "Window Start" } }, "required": [ "id", "trigger", "requested_by", "status", "due_at", "window_start", "window_end", "checks", "reason", "model_calls", "proposals", "created_at", "started_at", "finished_at" ], "title": "AnalysisRead", "type": "object" }, "Answer": { "description": "Core's reading of what one model call answered.\n\nThe counterpart of the elements: those are Core's reading of what *went*, this is Core's\nreading of what *came back*. Not the vendor's bytes -- those stay in `response`, untouched\n-- and not a second copy of them either, because for a streamed call there is no assembled\nbody to copy from: this is the accumulated turn the port itself acted on, which is the only\nplace the last round's answer exists at all (`app.providers.model_port.ModelTurn`).\n\n**No `reasoning_blocks`.** The provider's signed thinking blocks are replay material for the\nmodel that signed them and never content a reader is shown; `reasoning` is the summary a\ncaller may read, and it is the only thinking in here.", "properties": { "reasoning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the reasoning summary the model exposed, the same one a caller may read; never the provider's signed reasoning blocks", "title": "Reasoning" }, "refusal": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the refusal, when the model declined to answer", "title": "Refusal" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "what the model said, when it replied with text", "title": "Text" }, "tool_calls": { "description": "the tool calls this answer asked for, in the order the model made them; empty for an answer that asked for none", "items": { "$ref": "#/components/schemas/AnswerToolCall" }, "title": "Tool Calls", "type": "array" } }, "title": "Answer", "type": "object" }, "AnswerToolCall": { "description": "One tool call the model's answer asked for, as Core read it off the message.\n\n`ElementToolCall` above is the same fact about an *earlier* round and is deliberately not\nthis: that one points at the arguments as the vendor received them, because the words are in\nthe body beside it. Nothing in this document holds the bytes of the answer in a readable\nshape -- a streamed call records its chunks and no assembled body -- so the answer's own\ncalls carry the arguments Core parsed, as the compact JSON string every later round is\nreplayed from (`app.providers.model_port.ModelToolCall`).", "properties": { "arguments": { "description": "the arguments the model wrote, as the compact, key-sorted JSON string Core read them into", "title": "Arguments", "type": "string" }, "call_id": { "description": "the model's own id for this call, correlating it to result", "title": "Call Id", "type": "string" }, "name": { "description": "the tool the model asked for, as it named it", "title": "Name", "type": "string" } }, "required": [ "call_id", "name", "arguments" ], "title": "AnswerToolCall", "type": "object" }, "ApiConnectorCreate": { "additionalProperties": false, "description": "Body of `POST /api_connectors`.", "properties": { "auth": { "anyOf": [ { "discriminator": { "mapping": { "api_key": "#/components/schemas/ApiKeyAuth", "basic": "#/components/schemas/BasicAuth", "bearer": "#/components/schemas/BearerAuth", "none": "#/components/schemas/NoAuth", "oauth_authorization_code": "#/components/schemas/OAuthAuthorizationCodeAuth", "oauth_client_credentials": "#/components/schemas/OAuthClientCredentialsAuth" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/NoAuth" }, { "$ref": "#/components/schemas/BearerAuth" }, { "$ref": "#/components/schemas/ApiKeyAuth" }, { "$ref": "#/components/schemas/BasicAuth" }, { "$ref": "#/components/schemas/OAuthClientCredentialsAuth" }, { "$ref": "#/components/schemas/OAuthAuthorizationCodeAuth" } ] }, { "type": "null" } ], "description": "how Core authenticates to this endpoint; omitted means none. Written once and never read back", "title": "Auth" }, "background": { "anyOf": [ { "$ref": "#/components/schemas/ToolBackground" }, { "type": "null" } ], "description": "whether a turn may start this connector as a task, for how long, and whether its call may be sent again after an interruption; omitted means never" }, "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this version reads: a JSON Schema object with one property per `{@name}` in `http_url` and `request`, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; they are filled in after the install values and before the arguments, are never offered to the model, and stand where an install value may, never in the scheme, host or port. Every `{@name}` must be declared and every declaration used, and a name may not also be an argument or an install value; omitted declares none" }, "description": { "description": "What the tool does, shown to the model", "maxLength": 1024, "title": "Description", "type": "string" }, "http_url": { "description": "http(s) endpoint Core calls on the model's behalf", "maxLength": 2048, "pattern": "^https?://", "title": "Http Url", "type": "string" }, "install_values": { "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/InstallValue" }, { "$ref": "#/components/schemas/SecretInstallValue" }, { "$ref": "#/components/schemas/KeptSecret" } ] }, "description": "A typed value for every `{$name}` in `http_url` and `request`, by name: `{type, value, allowed, description}`, a `string`, `number` or `enum` as a shared bundle's parameters are, or a `secret`. Filled in before a call's arguments, never offered to the model and never one of `parameters`: percent-encoded in the URL's path or query, as text in a query or header value, and as the value itself, of its own type, where a body string is exactly one token. Never in the scheme, host or port; every token needs a value and every value must be used, and a value may not contain `{` or `}`. A `secret` (at most 8,192 characters) is sealed, filled in at call time, stands only in a header value or a body string, and is read back as `{type: \"secret\", has_value}`; a write replacing the values carries it again or `{\"$keep\": true}`. A copy a publication installed carries the installer's plain values already written in, and only its secrets here", "maxProperties": 64, "title": "Install Values", "type": "object" }, "labels": { "default": {}, "description": "The organisation's classification of this connector, as label -> value; what the rules over `tool` read", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the connector, at most 16 KiB serialised: stored, returned and never read by Core; omitted or null stores {}", "title": "Metadata" }, "name": { "description": "Connector name, unique per tenant; the model sees `api__`", "pattern": "^[a-z0-9_-]{1,48}$", "title": "Name", "type": "string" }, "parameters": { "additionalProperties": true, "description": "JSON Schema object for the tool's arguments", "title": "Parameters", "type": "object" }, "region": { "anyOf": [ { "pattern": "^(eu|us|in-cluster|global|[a-z]{2})$", "type": "string" }, { "type": "null" } ], "description": "where this connector's host is served, as you assert it: a jurisdiction ('eu', 'us', 'in-cluster', 'global') or an ISO 3166-1 alpha-2 country code ('nl'), spelled exactly as `policy.settings.regions_allow` is. A key whose `regions_allow` narrows it reaches the host only when an entry of its list contains this region ('nl' lies inside 'eu', everything inside 'global'), and never past a `host_regions` entry of the key's or the organisation's policy that places the host more widely -- unless every strict document names the host in `policy.settings.region_exceptions`. Omitted or null leaves the host to those `policy.settings.host_regions` alone", "title": "Region" }, "request": { "anyOf": [ { "$ref": "#/components/schemas/HttpRequestTemplate" }, { "type": "null" } ], "description": "the request this connector sends instead of the fixed contract: method, query, headers, body and timeout, with `{argument}` placeholders. Omitted keeps the fixed contract, and http_url may then carry no placeholder" }, "vendor": { "anyOf": [ { "$ref": "#/components/schemas/VendorOrigin" }, { "type": "null" } ], "description": "who runs this host, as you state it: where the company serving it is established (`established_in`) and where that company's ultimate parent is (`parent_in`), each a zone ('eu', 'us', 'global') or an ISO 3166-1 alpha-2 country code, never 'in-cluster'. A key or organisation whose `policy.settings.vendors_allow` names places reaches the host only when they contain what is stated; a fact left out is 'global', which only a requirement naming 'global' admits" } }, "required": [ "name", "description", "http_url" ], "title": "ApiConnectorCreate", "type": "object" }, "ApiConnectorRead": { "description": "An API connector, as `POST`/`GET`/`PATCH` return it.\n\nBuilt by `of` rather than by `model_validate`, because `auth` is three columns on the row and\none object on the wire, and nothing may answer it by serialising the row's own fields -- one\nof those columns is the sealed secret.", "properties": { "auth": { "$ref": "#/components/schemas/SourceAuthRead", "description": "how Core authenticates to this endpoint" }, "background": { "anyOf": [ { "$ref": "#/components/schemas/ToolBackground" }, { "type": "null" } ], "description": "whether a turn may start this connector as a task, for how long, and whether its call may be sent again after an interruption; null is never" }, "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this version reads: a JSON Schema object with one property per `{@name}` in `http_url` and `request`, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; they are filled in after the install values and before the arguments, are never offered to the model, and stand where an install value may, never in the scheme, host or port. Every `{@name}` must be declared and every declaration used, and a name may not also be an argument or an install value. A sealed copy answers them too, because a caller must know what to send; the template that places them stays withheld" }, "created_at": { "description": "When this connector was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created this connector", "title": "Created By", "type": "string" }, "description": { "description": "What the tool does, shown to the model", "title": "Description", "type": "string" }, "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "egress": { "description": "Every host a call through this source dials -- its own, and its token endpoint's where its credential names one -- each with whether the organisation's allowed hosts permit it and whether the deployment blocks it, as of this read. A host that is not allowed, or is blocked, is refused at the first call; an administrator adds it under the organisation's allowed hosts", "items": { "$ref": "#/components/schemas/HostAccess" }, "title": "Egress", "type": "array" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "http_url": { "description": "http(s) endpoint Core calls on the model's behalf; a sealed copy answers the origin only -- scheme and host -- so a subscriber can still see where its keys call", "title": "Http Url", "type": "string" }, "id": { "description": "API connector id", "title": "Id", "type": "string" }, "install_values": { "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/InstallValue" }, { "$ref": "#/components/schemas/SecretInstallValueRead" } ] }, "description": "A typed value for every `{$name}` in `http_url` and `request`, by name: `{type, value, allowed, description}`, a `string`, `number` or `enum` as a shared bundle's parameters are, or a `secret`. Filled in before a call's arguments, never offered to the model and never one of `parameters`: percent-encoded in the URL's path or query, as text in a query or header value, and as the value itself, of its own type, where a body string is exactly one token. Never in the scheme, host or port; every token needs a value and every value must be used, and a value may not contain `{` or `}`. A `secret` (at most 8,192 characters) is sealed, filled in at call time, stands only in a header value or a body string, and is read back as `{type: \"secret\", has_value}`; a write replacing the values carries it again or `{\"$keep\": true}`. A copy a publication installed carries the installer's plain values already written in, and only its secrets here; empty for a sealed copy", "title": "Install Values", "type": "object" }, "labels": { "default": {}, "description": "The organisation's classification of this connector, as label -> value; every one of its operations carries it", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "latest_version": { "description": "The highest published version, which keys read and turns call; 0 for a connector with only drafts", "title": "Latest Version", "type": "integer" }, "metadata": { "additionalProperties": true, "default": {}, "description": "The opaque document attached to this connector; {} when none was set", "title": "Metadata", "type": "object" }, "name": { "description": "Connector name, unique per tenant; the model sees `api__`", "title": "Name", "type": "string" }, "object": { "const": "api_connector", "default": "api_connector", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/OriginRead" }, { "type": "null" } ], "description": "where this connector came from when a subscription installed it; null for one this organisation registered itself" }, "parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "JSON Schema object for the tool's arguments; null when the publication that shared this connector sealed it", "title": "Parameters" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "where this connector's host is served, as its registrant asserted it; null when nobody did, and the key's own `policy.settings.host_regions` then places the host", "title": "Region" }, "request": { "anyOf": [ { "$ref": "#/components/schemas/HttpRequestTemplate" }, { "type": "null" } ], "description": "the request this connector sends, as stored; null means the fixed contract, and null also when the publication that shared this connector sealed it" }, "updated_at": { "description": "When this connector was last updated", "format": "date-time", "title": "Updated At", "type": "string" }, "vendor": { "$ref": "#/components/schemas/VendorOrigin", "description": "who runs this host, as its registrant stated it; each fact null where nobody did, which `policy.settings.vendors_allow` reads as 'global'" }, "version": { "description": "the version the flat fields above are: the latest published one, or, for a connector with only drafts, which only the management twin reads, its newest draft", "title": "Version", "type": "integer" } }, "required": [ "id", "name", "description", "parameters", "http_url", "request", "auth", "vendor", "version", "latest_version", "created_by", "created_at", "updated_at" ], "title": "ApiConnectorRead", "type": "object" }, "ApiConnectorUpdate": { "additionalProperties": false, "description": "Body of `PATCH /api_connectors/{connector_id}`; every field is optional and left alone when\nabsent. `name` never changes after creation, so it has no field here: the qualified name a\npolicy glob, a usage row and an audit subject all carry is built from it.", "properties": { "auth": { "anyOf": [ { "discriminator": { "mapping": { "api_key": "#/components/schemas/ApiKeyAuth", "basic": "#/components/schemas/BasicAuth", "bearer": "#/components/schemas/BearerAuth", "none": "#/components/schemas/NoAuth", "oauth_authorization_code": "#/components/schemas/OAuthAuthorizationCodeAuth", "oauth_client_credentials": "#/components/schemas/OAuthClientCredentialsAuth" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/NoAuth" }, { "$ref": "#/components/schemas/BearerAuth" }, { "$ref": "#/components/schemas/ApiKeyAuth" }, { "$ref": "#/components/schemas/BasicAuth" }, { "$ref": "#/components/schemas/OAuthClientCredentialsAuth" }, { "$ref": "#/components/schemas/OAuthAuthorizationCodeAuth" } ] }, { "type": "null" } ], "description": "new credential, replacing whatever is stored; omitted leaves the sealed bytes alone, and `{\"type\": \"none\"}` clears them", "title": "Auth" }, "background": { "anyOf": [ { "$ref": "#/components/schemas/ToolBackground" }, { "type": "null" } ], "description": "new background setting, replacing whatever is stored and making a new version; an explicit null clears it back to never, and a body that omits the field leaves it alone" }, "call_variables": { "anyOf": [ { "$ref": "#/components/schemas/CallVariables" }, { "type": "null" } ], "description": "new call variables, replacing the whole declaration and making a new version; omitted leaves them alone. The call variables this version reads: a JSON Schema object with one property per `{@name}` in `http_url` and `request`, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; they are filled in after the install values and before the arguments, are never offered to the model, and stand where an install value may, never in the scheme, host or port. Every `{@name}` must be declared and every declaration used, and a name may not also be an argument or an install value" }, "description": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "What the tool does, shown to the model", "title": "Description" }, "http_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https?://", "type": "string" }, { "type": "null" } ], "description": "new http(s) endpoint Core calls on the model's behalf", "title": "Http Url" }, "install_values": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/InstallValue" }, { "$ref": "#/components/schemas/SecretInstallValue" }, { "$ref": "#/components/schemas/KeptSecret" } ] }, "maxProperties": 64, "type": "object" }, { "type": "null" } ], "description": "new install values, replacing every stored one; omitted leaves them alone, and {} clears them. A typed value for every `{$name}` in `http_url` and `request`, by name: `{type, value, allowed, description}`, a `string`, `number` or `enum` as a shared bundle's parameters are, or a `secret`. Filled in before a call's arguments, never offered to the model and never one of `parameters`: percent-encoded in the URL's path or query, as text in a query or header value, and as the value itself, of its own type, where a body string is exactly one token. Never in the scheme, host or port; every token needs a value and every value must be used, and a value may not contain `{` or `}`. A `secret` (at most 8,192 characters) is sealed, filled in at call time, stands only in a header value or a body string, and is read back as `{type: \"secret\", has_value}`; a write replacing the values carries it again or `{\"$keep\": true}`. A copy a publication installed carries the installer's plain values already written in, and only its secrets here", "title": "Install Values" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "new classification of this connector, replacing whatever is stored; omitted leaves it alone, and an empty map clears it", "title": "Labels" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "new opaque document, replacing whatever is stored whole; omitted leaves it alone, and {} clears it", "title": "Metadata" }, "parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "JSON Schema object for the tool's arguments", "title": "Parameters" }, "region": { "anyOf": [ { "pattern": "^(eu|us|in-cluster|global|[a-z]{2})$", "type": "string" }, { "type": "null" } ], "description": "new region this connector's host is served in, replacing whatever is stored. An explicit null clears it, leaving the host to the key's own `policy.settings.host_regions`; a field the body omits leaves the stored region alone", "title": "Region" }, "request": { "anyOf": [ { "$ref": "#/components/schemas/HttpRequestTemplate" }, { "type": "null" } ], "description": "new request template, replacing whatever is stored. An explicit null clears it back to the fixed contract; a field the body omits leaves the stored template alone" }, "vendor": { "anyOf": [ { "$ref": "#/components/schemas/VendorOrigin" }, { "type": "null" } ], "description": "new statement of who runs this host, replacing whatever is stored; an explicit null clears it back to nothing stated, and a body that omits the field leaves it alone" } }, "title": "ApiConnectorUpdate", "type": "object" }, "ApiConnectorVersionRead": { "description": "One immutable version of a connector, as `GET /api_connectors/{id}/versions` lists it.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "background": { "anyOf": [ { "$ref": "#/components/schemas/ToolBackground" }, { "type": "null" } ], "description": "whether this version may be started as a task, for how long, and whether its call may be sent again after an interruption; null is never" }, "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this version reads: a JSON Schema object with one property per `{@name}` in `http_url` and `request`, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; they are filled in after the install values and before the arguments, are never offered to the model, and stand where an install value may, never in the scheme, host or port. Every `{@name}` must be declared and every declaration used, and a name may not also be an argument or an install value. A sealed copy answers them too, because a caller must know what to send; the template that places them stays withheld" }, "connector_id": { "description": "Connector this version belongs to", "title": "Connector Id", "type": "string" }, "created_at": { "description": "When this version was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created this version", "title": "Created By", "type": "string" }, "description": { "description": "What the tool does, shown to the model", "title": "Description", "type": "string" }, "http_url": { "description": "http(s) endpoint Core calls on the model's behalf; a sealed copy answers the origin only -- scheme and host -- so a subscriber can still see where its keys call", "title": "Http Url", "type": "string" }, "id": { "description": "API connector version id", "title": "Id", "type": "string" }, "install_values": { "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/InstallValue" }, { "$ref": "#/components/schemas/SecretInstallValueRead" } ] }, "description": "A typed value for every `{$name}` in `http_url` and `request`, by name: `{type, value, allowed, description}`, a `string`, `number` or `enum` as a shared bundle's parameters are, or a `secret`. Filled in before a call's arguments, never offered to the model and never one of `parameters`: percent-encoded in the URL's path or query, as text in a query or header value, and as the value itself, of its own type, where a body string is exactly one token. Never in the scheme, host or port; every token needs a value and every value must be used, and a value may not contain `{` or `}`. A `secret` (at most 8,192 characters) is sealed, filled in at call time, stands only in a header value or a body string, and is read back as `{type: \"secret\", has_value}`; a write replacing the values carries it again or `{\"$keep\": true}`. A copy a publication installed carries the installer's plain values already written in, and only its secrets here; empty for a sealed copy", "title": "Install Values", "type": "object" }, "object": { "const": "api_connector_version", "default": "api_connector_version", "description": "The object's type", "title": "Object", "type": "string" }, "parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "JSON Schema object for the tool's arguments; null when the publication that shared this connector sealed it", "title": "Parameters" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "request": { "anyOf": [ { "$ref": "#/components/schemas/HttpRequestTemplate" }, { "type": "null" } ], "description": "the request this version sends, as stored; null means the fixed contract, and null also when the publication that shared this connector sealed it" }, "sealed": { "default": false, "description": "Whether this version was installed under sealed terms, so its content is withheld here for good -- whatever a later version of the same copy says, and after a fork. A version this organisation wrote itself is never sealed", "title": "Sealed", "type": "boolean" }, "state": { "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" } }, "required": [ "id", "connector_id", "version", "description", "parameters", "http_url", "request", "state", "created_by", "acted_for", "created_at" ], "title": "ApiConnectorVersionRead", "type": "object" }, "ApiKeyAuth": { "additionalProperties": false, "description": "A key sent either as one header or as one query parameter, as the far end asks for it.", "properties": { "name": { "description": "Header name (header placement) or query key (query placement); a header name matches ^[A-Za-z0-9-]{1,64}$ and may not be one a request template is refused", "maxLength": 128, "title": "Name", "type": "string" }, "placement": { "description": "Whether the key is sent as a header or as a query parameter", "enum": [ "header", "query" ], "title": "Placement", "type": "string" }, "secret": { "description": "The key itself; write-only, sealed at rest and never returned", "maxLength": 4096, "minLength": 1, "title": "Secret", "type": "string" }, "type": { "const": "api_key", "default": "api_key", "description": "authentication kind", "title": "Type", "type": "string" } }, "required": [ "placement", "name", "secret" ], "title": "ApiKeyAuth", "type": "object" }, "AppendItems": { "additionalProperties": false, "description": "Items to append to an existing thread.", "properties": { "items": { "description": "items to append", "items": { "discriminator": { "mapping": { "custom_tool_call": "#/components/schemas/CustomToolCallInput", "custom_tool_call_output": "#/components/schemas/CustomToolCallOutputInput", "function_call": "#/components/schemas/FunctionCallInput", "function_call_output": "#/components/schemas/FunctionCallOutputInput", "message": "#/components/schemas/MessageInput", "reasoning": "#/components/schemas/ReasoningInput" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/MessageInput" }, { "$ref": "#/components/schemas/FunctionCallInput" }, { "$ref": "#/components/schemas/FunctionCallOutputInput" }, { "$ref": "#/components/schemas/CustomToolCallInput" }, { "$ref": "#/components/schemas/CustomToolCallOutputInput" }, { "$ref": "#/components/schemas/ReasoningInput" } ] }, "maxItems": 100, "minItems": 1, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "AppendItems", "type": "object" }, "AppliedRateRead": { "description": "The exchange rate a catalogue price was converted to euro by.", "properties": { "rate_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "the ECB publication day of the rate; null for a rate the operator typed when closing a month", "title": "Rate Date" }, "units_per_euro": { "description": "how many units of the listed currency one euro buys; the euro amounts are the listed ones divided by this", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Units Per Euro", "type": "string" } }, "required": [ "units_per_euro", "rate_date" ], "title": "AppliedRateRead", "type": "object" }, "ApprovalDecision": { "additionalProperties": false, "description": "Body of `POST /responses/{response_id}/approvals/{approval_id}`: OpenAI's\n`mcp_approval_response`, without the id the path already names.", "properties": { "approve": { "description": "true runs the call; false answers it without running it", "title": "Approve", "type": "boolean" }, "reason": { "anyOf": [ { "maxLength": 2000, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "why, in the deciding person's words: on a rejection the model reads it as the call's result; never in the trail or on the event feed", "title": "Reason" } }, "required": [ "approve" ], "title": "ApprovalDecision", "type": "object" }, "ApprovalEntry": { "additionalProperties": false, "description": "One tool, or every tool a glob matches, and the mode its calls run under.", "properties": { "approval": { "description": "`always` parks every call without asking the model, `never` runs it, and `model` parks a call unless the model marked it `request_approval: false`", "enum": [ "never", "model", "always" ], "title": "Approval", "type": "string" }, "name": { "description": "a qualified tool name as the model is offered it, or an fnmatch glob over those names, e.g. `mail__acme-support__*`; an exact name beats every glob", "pattern": "^[A-Za-z0-9_.*?\\[\\]-]{1,64}$", "title": "Name", "type": "string" } }, "required": [ "name", "approval" ], "title": "ApprovalEntry", "type": "object" }, "ArtifactRead": { "description": "One artifact's metadata, as the artifacts API returns it.\n\nCarries no expiry: an artifact is a file in the calling key's own collection and leaves with\nthe organisation's retention window, rather than on a 30-day clock of its own\n(`docs/architecture/files-and-artifacts.md`).", "properties": { "bytes": { "description": "Size in bytes", "title": "Bytes", "type": "integer" }, "call_id": { "description": "Tool call that produced this artifact", "title": "Call Id", "type": "string" }, "collection_id": { "description": "Knowledge collection this artifact lives in: the producing key's own", "title": "Collection Id", "type": "string" }, "created_at": { "description": "When this artifact was recorded", "format": "date-time", "title": "Created At", "type": "string" }, "deleted_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this artifact was deleted into the trash, where every read but the trash's own listing skips it; null while it is live", "title": "Deleted At" }, "filename": { "description": "The artifact's filename: the one its tool gave it, or `-`", "title": "Filename", "type": "string" }, "folder": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The folder this artifact sits in, a normalised `/`-separated path such as `reports/2026`; null at the collection's root", "title": "Folder" }, "id": { "description": "Artifact id", "title": "Id", "type": "string" }, "index_status": { "anyOf": [ { "enum": [ "queued", "processing", "ready", "failed" ], "type": "string" }, { "type": "null" } ], "description": "How far this artifact's own ingestion has got, over every index that draws it in: 'ready' when it can be searched, 'queued' or 'processing' while it is still being ingested, 'failed' when it could not be; null when no index holds it", "title": "Index Status" }, "media_type": { "description": "MIME type of the artifact's bytes", "title": "Media Type", "type": "string" }, "object": { "const": "artifact", "default": "artifact", "description": "The object's type", "title": "Object", "type": "string" }, "purge_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the trash purges this artifact with its bytes, unless it is restored first; null while it is live", "title": "Purge At" }, "response_id": { "description": "Response whose turn produced this artifact", "title": "Response Id", "type": "string" }, "retention": { "description": "'window' if the organisation's retention window covers this artifact, 'keep' if it stays until something deletes it", "enum": [ "window", "keep" ], "title": "Retention", "type": "string" }, "sha256": { "description": "SHA-256 hex digest of the artifact's bytes", "title": "Sha256", "type": "string" }, "tool_name": { "description": "Name of the tool that produced this artifact", "title": "Tool Name", "type": "string" }, "viewable": { "description": "Whether this artifact can be opened as a page: true when it is stored as `text/html`. A view, a share link and a page are refused `409` for one that says false", "title": "Viewable", "type": "boolean" } }, "required": [ "id", "response_id", "call_id", "tool_name", "filename", "collection_id", "retention", "media_type", "bytes", "sha256", "viewable", "created_at" ], "title": "ArtifactRead", "type": "object" }, "ArtifactUpdate": { "additionalProperties": false, "description": "Body of `PATCH /artifacts/{artifact_id}`; absent fields are left alone.", "properties": { "collection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The collection to move the artifact into: only between collections that hold files, a key's own and the organisation's `uploads`, and only one the caller reaches, else `422`. Its retention stays its own", "title": "Collection Id" }, "filename": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "New filename, stripped to its last path component", "title": "Filename" }, "folder": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "The folder to move the artifact into, a `/`-separated path Core normalises; empty or `/` moves it to the collection's root", "title": "Folder" }, "retention": { "anyOf": [ { "enum": [ "window", "keep" ], "type": "string" }, { "type": "null" } ], "description": "'window' lets the organisation's retention window take the artifact once it is older than the window, 'keep' keeps it until something deletes it", "title": "Retention" } }, "title": "ArtifactUpdate", "type": "object" }, "ArtifactsConfig": { "additionalProperties": false, "description": "The `artifacts` capability: whether a tool's binary output is kept at all.\n\nIt carries nothing to configure. An artifact used to hold a `retention_days` of its own and be\nswept on it; it is a file in the key's own collection now, and how long it is kept is the\norganisation's retention window and the source's own `retention` flag\n(`docs/architecture/files-and-artifacts.md`). The capability remains the switch -- and still\nrequires `files`, since both are bytes in a blob.", "properties": {}, "title": "ArtifactsConfig", "type": "object" }, "AssetRead": { "description": "One of an organisation's brand images, without its bytes.", "properties": { "content_type": { "description": "The image type the stored bytes are: image/png, image/jpeg or image/webp", "title": "Content Type", "type": "string" }, "created_at": { "description": "When the slot was first filled", "format": "date-time", "title": "Created At", "type": "string" }, "object": { "const": "organisation_asset", "default": "organisation_asset", "description": "The object's type", "title": "Object", "type": "string" }, "sha256": { "description": "Hex sha256 of the image, which names its public address", "title": "Sha256", "type": "string" }, "size_bytes": { "description": "How many bytes the image holds", "title": "Size Bytes", "type": "integer" }, "slot": { "description": "The organisation's own name for the image, such as `logo`", "title": "Slot", "type": "string" }, "updated_at": { "description": "When the slot's image was last replaced", "format": "date-time", "title": "Updated At", "type": "string" }, "url": { "description": "Where anyone may read the image without a credential, cacheable for a year; a new image in the slot has a new address", "title": "Url", "type": "string" } }, "required": [ "slot", "content_type", "size_bytes", "sha256", "url", "created_at", "updated_at" ], "title": "AssetRead", "type": "object" }, "AssistConfig": { "additionalProperties": false, "description": "The `assist` capability: the helpers that write a piece of configuration from a plain\ndescription -- a JSON Schema first -- by one call to the organisation's helper model\n(`docs/architecture/assist.md`).\n\nNo configuration and no dependency. Which model answers is the organisation's setting, not a\nkey's (`app.assist.model.effective_assist_model`), and what a helper returns is never stored,\nso there is nothing another capability would have to hold first. It is a switch of its own\nrather than something every key simply has because each call spends the organisation's money\non a model, which is exactly what a key should be given on purpose.", "properties": {}, "title": "AssistConfig", "type": "object" }, "AssistStatusRead": { "description": "Which model this organisation's helpers call, or that none is configured -- what a console\nreads to explain a helper it cannot offer.", "properties": { "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The catalogue chat model the helpers call for this organisation; null when neither the organisation nor the deployment names one, and every helper then answers 409", "title": "Model" }, "object": { "const": "assist", "default": "assist", "description": "The object's type", "title": "Object", "type": "string" }, "source": { "anyOf": [ { "enum": [ "organisation", "deployment" ], "type": "string" }, { "type": "null" } ], "description": "Where that model came from: 'organisation' when the organisation chose it (assist_model on the organisation), 'deployment' when it follows the deployment's default; null when there is no model", "title": "Source" } }, "required": [ "model", "source" ], "title": "AssistStatusRead", "type": "object" }, "AttributeHas": { "additionalProperties": false, "description": "Holds when the named person's values for `attribute` include `value`: a condition on the\nperson alone, which reads nothing off the thing.", "properties": { "atom": { "const": "attribute_has", "default": "attribute_has", "description": "holds when the person's values for an attribute include one value", "title": "Atom", "type": "string" }, "attribute": { "description": "the attribute of the person the request names", "pattern": "^[A-Za-z0-9_.:-]{1,64}$", "title": "Attribute", "type": "string" }, "value": { "description": "the one value the person's values for `attribute` must include, compared with case; either of two values is two rules", "maxLength": 256, "minLength": 1, "title": "Value", "type": "string" } }, "required": [ "attribute", "value" ], "title": "AttributeHas", "type": "object" }, "AttributeMatch": { "additionalProperties": false, "description": "A value a person may write when it is one of her values for one attribute.", "properties": { "attribute": { "description": "name of the attribute this request must carry a matching value for", "pattern": "^[A-Za-z0-9_.:-]{1,64}$", "title": "Attribute", "type": "string" } }, "required": [ "attribute" ], "title": "AttributeMatch", "type": "object" }, "AuditEventRead": { "description": "One audit row, as the key and operator audit APIs return it.", "properties": { "actor": { "description": "The acting key's id, or 'operator:' for a human management action", "title": "Actor", "type": "string" }, "attempts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "How many identical attempts this refusal row stands for: a refusal repeated inside one coalescing window is written once and counted here, its first attempt included. Null for every row that is not a coalesced refusal, each of which is one event", "title": "Attempts" }, "axis": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Policy axis this event decided on, for a policy.decision event", "title": "Axis" }, "created_at": { "description": "When this event was recorded", "format": "date-time", "title": "Created At", "type": "string" }, "decision": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "'allowed' or 'denied', for a policy.decision event", "title": "Decision" }, "event": { "description": "Event name", "title": "Event", "type": "string" }, "id": { "description": "Audit event id", "title": "Id", "type": "string" }, "key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Key that caused this event; null for an operator action", "title": "Key Id" }, "object": { "const": "audit_event", "default": "audit_event", "description": "The object's type", "title": "Object", "type": "string" }, "occurred_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the product says its event happened, as it said it; `created_at` is when Core recorded it. Null for Core's own events", "title": "Occurred At" }, "origin": { "description": "Who wrote this event: `core` for every event Core recorded itself, `product` for one a product built on Core delivered, named by `product` and `product_name`. Never null", "enum": [ "core", "product" ], "readOnly": true, "title": "Origin", "type": "string" }, "product": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The namespace of the product built on Core that delivered this event through `POST /audit/events`; null exactly when `origin` is `core`", "title": "Product" }, "product_event_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The product's own id for the event it delivered; null for Core's own events", "title": "Product Event Id" }, "product_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "That product's display name as it stood when the event was delivered; a later rename leaves it as it was. Null exactly when `origin` is `core`", "title": "Product Name" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Fixed-wording reason, for a policy.decision event", "title": "Reason" }, "refs": { "additionalProperties": true, "description": "Ids, names, versions and labels this event references", "title": "Refs", "type": "object" }, "request_id": { "description": "Id of the request that caused this event", "title": "Request Id", "type": "string" }, "response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Response this event belongs to, when any", "title": "Response Id" }, "span_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Span within that trace; null when the deployment exports no telemetry", "title": "Span Id" }, "subject_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the request that wrote this row was for -- the calling application's own opaque identifier, or null for a request that named nobody (docs/architecture/subjects.md)", "title": "Subject Id" }, "tenant_id": { "description": "Owning tenant id", "title": "Tenant Id", "type": "string" }, "trace_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Trace this event was recorded in; null when the deployment exports no telemetry", "title": "Trace Id" } }, "required": [ "id", "tenant_id", "key_id", "actor", "request_id", "trace_id", "span_id", "response_id", "event", "axis", "decision", "reason", "refs", "created_at", "origin" ], "title": "AuditEventRead", "type": "object" }, "AuthorizationCreate": { "additionalProperties": false, "description": "Body of `POST /{sources}/{id}/authorizations`.", "properties": { "return_url": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "description": "the application's own page to send the person back to once they have granted or declined, with `authorization=granted|denied` appended. Omitted leaves them on a page of Core's own carrying one sentence", "title": "Return Url" }, "user": { "description": "the calling application's own opaque identifier of the person to connect -- the same value its `POST /responses` will send as `user`, and never a name or an address", "pattern": "^[A-Za-z0-9._:@-]{1,128}$", "title": "User", "type": "string" } }, "required": [ "user" ], "title": "AuthorizationCreate", "type": "object" }, "AuthorizationRead": { "description": "What `GET /{sources}/{id}/authorizations/{user}` answers about one person.", "properties": { "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "when the stored access token expires; null when there is no grant, or when the provider stated no lifetime", "title": "Expires At" }, "granted": { "description": "whether Core holds a grant for this person at this source. False also covers a grant a failed refresh has since forgotten, which is the same thing to a caller: the person has to grant again", "title": "Granted", "type": "boolean" }, "object": { "const": "authorization", "default": "authorization", "description": "The object's type", "title": "Object", "type": "string" }, "scopes": { "description": "what the provider said this grant covers; empty when there is no grant", "items": { "type": "string" }, "title": "Scopes", "type": "array" }, "user": { "description": "the person this answers about, as the application named them", "title": "User", "type": "string" } }, "required": [ "user", "granted", "expires_at", "scopes" ], "title": "AuthorizationRead", "type": "object" }, "AuthorizationUrlRead": { "description": "What `POST /{sources}/{id}/authorizations` answers: where to send this person, and how\nlong that is worth doing.", "properties": { "expires_at": { "description": "when this url stops being worth opening; ask for another one after that", "format": "date-time", "title": "Expires At", "type": "string" }, "object": { "const": "authorization_url", "default": "authorization_url", "description": "The object's type", "title": "Object", "type": "string" }, "url": { "description": "the provider's own authorization endpoint, with everything this person's grant needs. Hand it to the person; Core never opens it", "title": "Url", "type": "string" } }, "required": [ "url", "expires_at" ], "title": "AuthorizationUrlRead", "type": "object" }, "AvailableMemberRead": { "additionalProperties": false, "description": "One member of a publication an organisation is deciding whether to install: what it is,\nwhat it will be called, and -- only where the terms allow it -- what it says.", "properties": { "definition": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The body this member installs, with its `$member` and `$param` markers unresolved -- and `null` when the version withholds it: a sealed publication, or one whose terms ask for an entitlement this organisation does not hold", "title": "Definition" }, "kind": { "description": "Which library this member installs into", "enum": [ "prompt", "skill", "toolset", "agent", "collection", "pipeline", "index", "retrieval_tool", "evaluation", "api_connector", "mcp_server", "sql_connector", "tool_alias", "script", "workflow" ], "title": "Kind", "type": "string" }, "name": { "description": "The member's name; a subscription's prefix is glued onto it", "title": "Name", "type": "string" }, "when": { "anyOf": [ { "$ref": "#/components/schemas/When" }, { "type": "null" } ], "description": "The condition this member installs under, over one enum parameter; null installs it always. Answered even when the definition is withheld: which choice switches which member on is part of the offer, not of the body" } }, "required": [ "kind", "name" ], "title": "AvailableMemberRead", "type": "object" }, "AvailablePublicationRead": { "description": "One publication this organisation may install, with everything it needs to decide: what the\nbundle holds, what it asks for, and the terms it is offered under.\n\nA separate shape from `PublicationRead` because the question is different -- that one is about\na publication an organisation *owns*, this one about one it is being offered.\n\n**It is not the version's document.** `visibility: catalogue` makes this route readable by\nevery organisation of the deployment, subscribed or not, entitled or not, so answering the\nmanifest whole would hand every prompt template, every agent instruction, every skill body and\nevery connector request template to anybody who asked. What it always answers is the *shape* --\nthe kinds, the names, the parameters to fill in, what the bundle requires, the terms and the\nchangelog -- and the member definitions only when the terms withhold nothing and nothing is\nowed (`app.sharing.available.withholds_definitions`).", "properties": { "changelog": { "description": "What changed in that version", "title": "Changelog", "type": "string" }, "definitions_withheld": { "description": "Whether the member definitions above are withheld -- the version is sealed, or its terms ask for an entitlement this organisation does not hold. The parameters and everything else on this page are answered either way", "title": "Definitions Withheld", "type": "boolean" }, "members": { "description": "What the bundle holds: every member's kind and name, and its definition where the terms allow it", "items": { "$ref": "#/components/schemas/AvailableMemberRead" }, "title": "Members", "type": "array" }, "parameters": { "additionalProperties": { "$ref": "#/components/schemas/ParameterSpec" }, "description": "The values this organisation would supply, so a console can render the install form. Answered whether or not the definitions are: a bundle whose required parameter names nobody may read is a bundle nobody may install, and a name, a type and a default are not a body", "title": "Parameters", "type": "object" }, "publication": { "$ref": "#/components/schemas/PublicationRead", "description": "The publication itself" }, "requires": { "$ref": "#/components/schemas/Requires", "description": "What a subscriber needs for it to install at all" }, "terms": { "$ref": "#/components/schemas/Terms", "description": "What a subscriber may do with it" }, "version": { "description": "The version this would install: its latest", "title": "Version", "type": "integer" } }, "required": [ "publication", "version", "requires", "definitions_withheld", "terms", "changelog" ], "title": "AvailablePublicationRead", "type": "object" }, "Base64ImageSource": { "additionalProperties": false, "description": "An image carried inline, as Anthropic carries one.", "properties": { "data": { "description": "the image's bytes, base64-encoded", "title": "Data", "type": "string" }, "media_type": { "description": "the image's IANA media type", "title": "Media Type", "type": "string" }, "type": { "const": "base64", "default": "base64", "description": "image source kind", "title": "Type", "type": "string" } }, "required": [ "media_type", "data" ], "title": "Base64ImageSource", "type": "object" }, "BasicAuth": { "additionalProperties": false, "description": "RFC 7617: `Authorization: Basic base64(username:password)` on every request.", "properties": { "password": { "description": "The password half; write-only, sealed at rest and never returned", "maxLength": 4096, "minLength": 1, "title": "Password", "type": "string" }, "type": { "const": "basic", "default": "basic", "description": "authentication kind", "title": "Type", "type": "string" }, "username": { "description": "The user half of the credential", "maxLength": 256, "title": "Username", "type": "string" } }, "required": [ "username", "password" ], "title": "BasicAuth", "type": "object" }, "BearerAuth": { "additionalProperties": false, "description": "A static token sent in one header on every request Core makes to this source.\n\n**The value is sent exactly as stored**, under the named header and with nothing prepended.\nAn API that wants `Authorization: Bearer abc` is given a secret of `Bearer abc`; one that\nwants a bare token in `Authorization` is given the bare token. That is the shape an MCP\nregistration has sent since bearer credentials landed, and it stays byte for byte, so a\nregistration written then still authenticates now -- adding a `Bearer ` prefix here would\nhave turned a stored `Bearer abc` into `Bearer Bearer abc` for every one of them. It also\nleaves every scheme reachable (`Token`, `ApiKey`, a vendor's own) without a field for it.", "properties": { "header_name": { "default": "Authorization", "description": "Header the secret is sent in; defaults to Authorization. A header Core or the transport sets is refused", "pattern": "^[A-Za-z0-9-]{1,64}$", "title": "Header Name", "type": "string" }, "secret": { "description": "The credential value, sent under header_name exactly as stored: include `Bearer ` in it when the API expects the scheme. Write-only, sealed at rest and never returned", "maxLength": 4096, "minLength": 1, "title": "Secret", "type": "string" }, "type": { "const": "bearer", "default": "bearer", "description": "authentication kind", "title": "Type", "type": "string" } }, "required": [ "secret" ], "title": "BearerAuth", "type": "object" }, "Body_create_file_api_v1_files_post": { "properties": { "collection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Collection Id" }, "file": { "contentMediaType": "application/octet-stream", "format": "binary", "title": "File", "type": "string" }, "folder": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "the folder the file is put in, a `/`-separated path normalised by Core; empty or absent puts it at the collection's root", "title": "Folder" }, "labels": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the labels the rules over this row's kind read, as a JSON object of label -> a value or a list of values; multipart carries no types of its own, so the map is sent as a string", "title": "Labels" }, "purpose": { "maxLength": 64, "minLength": 1, "title": "Purpose", "type": "string" }, "retention": { "anyOf": [ { "enum": [ "window", "keep" ], "type": "string" }, { "type": "null" } ], "title": "Retention" } }, "required": [ "file", "purpose" ], "title": "Body_create_file_api_v1_files_post", "type": "object" }, "Body_create_transcription_api_v1_audio_transcriptions_post": { "properties": { "file": { "contentMediaType": "application/octet-stream", "format": "binary", "title": "File", "type": "string" }, "language": { "anyOf": [ { "pattern": "^[a-z]{2,3}$", "type": "string" }, { "type": "null" } ], "description": "the recording's language as an ISO 639-1 code ('nl'); left out, the model detects it", "title": "Language" }, "model": { "description": "catalogue id of an audio model", "maxLength": 200, "minLength": 1, "title": "Model", "type": "string" }, "prompt": { "anyOf": [ { "maxLength": 4000, "type": "string" }, { "type": "null" } ], "description": "text that guides the model: names, spellings, style", "title": "Prompt" }, "response_format": { "default": "json", "description": "json (the default), text, or verbose_json; srt and vtt are refused", "enum": [ "json", "text", "verbose_json" ], "title": "Response Format", "type": "string" }, "temperature": { "anyOf": [ { "maximum": 1.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "sampling temperature, 0 to 1", "title": "Temperature" } }, "required": [ "file", "model" ], "title": "Body_create_transcription_api_v1_audio_transcriptions_post", "type": "object" }, "Body_upload_source_api_v1_knowledge_collections__collection_id__sources_upload_post": { "properties": { "file": { "contentMediaType": "application/octet-stream", "format": "binary", "title": "File", "type": "string" }, "labels": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the labels the rules over this row's kind read, as a JSON object of label -> a value or a list of values; multipart carries no types of its own, so the map is sent as a string", "title": "Labels" }, "metadata": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Metadata" }, "retention": { "anyOf": [ { "enum": [ "window", "keep" ], "type": "string" }, { "type": "null" } ], "title": "Retention" }, "title": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Title" } }, "required": [ "file" ], "title": "Body_upload_source_api_v1_knowledge_collections__collection_id__sources_upload_post", "type": "object" }, "BroughtPackage": { "additionalProperties": false, "description": "A package the bundle carries because only its publisher approved it: installing the bundle\naccepts it for the scripts it copies, and for nothing of this organisation's own.", "properties": { "ecosystem": { "description": "`pypi` or `npm`", "title": "Ecosystem", "type": "string" }, "filename": { "description": "The file the bundle carries", "title": "Filename", "type": "string" }, "name": { "description": "The package's name", "title": "Name", "type": "string" }, "sha256": { "description": "SHA-256 hex digest of the file", "title": "Sha256", "type": "string" }, "size_bytes": { "description": "The file's length in bytes", "title": "Size Bytes", "type": "integer" }, "version": { "description": "The exact version", "title": "Version", "type": "string" } }, "required": [ "ecosystem", "name", "version", "filename", "size_bytes", "sha256" ], "title": "BroughtPackage", "type": "object" }, "CallVariableProperty": { "additionalProperties": false, "description": "One call variable: a variable that may also be a secret. A prompt's variable is never\none, because its value is rendered into what the model reads.", "properties": { "default": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ], "description": "the value a tool receives when the request gives none, of the property's own type; null for none, and a variable with a default is never required", "title": "Default" }, "description": { "default": "", "description": "what this variable holds, for callers", "maxLength": 500, "title": "Description", "type": "string" }, "enum": { "anyOf": [ { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ] }, "maxItems": 64, "minItems": 1, "type": "array" }, { "type": "null" } ], "description": "the only values this variable admits, each of its own type; null admits any value of the type, and a boolean takes none", "title": "Enum" }, "type": { "description": "the JSON type a value for this variable must have", "enum": [ "string", "number", "integer", "boolean" ], "title": "Type", "type": "string" }, "x-secret": { "default": false, "description": "`x-secret: true` marks a secret: a string with no default, sealed wherever Core keeps it and masked in the tool's result", "title": "X-Secret", "type": "boolean" } }, "required": [ "type" ], "title": "CallVariableProperty", "type": "object" }, "CallVariables": { "additionalProperties": false, "description": "The call variables a tool version reads, as one JSON Schema object: a property per\n`{@name}`, and the names a request must give a value for in `required`.", "properties": { "additionalProperties": { "const": false, "default": false, "description": "always false: no other variable is read", "title": "Additionalproperties", "type": "boolean" }, "properties": { "additionalProperties": { "$ref": "#/components/schemas/CallVariableProperty" }, "description": "one property per call variable, keyed by its name: lowercase letters, digits and underscore, at most 64", "maxProperties": 64, "title": "Properties", "type": "object" }, "required": { "description": "the variables a request must give a value for; never one with a default", "items": { "type": "string" }, "maxItems": 64, "title": "Required", "type": "array" }, "type": { "const": "object", "default": "object", "description": "always `object`", "title": "Type", "type": "string" } }, "title": "CallVariables", "type": "object" }, "CandidateRead": { "description": "One pool member as a routed turn saw it.", "properties": { "model": { "description": "The pool member", "title": "Model", "type": "string" }, "outcome": { "description": "`kept`, or why it was dropped: `unknown_model`, `capability`, `policy` or `price`", "title": "Outcome", "type": "string" } }, "required": [ "model", "outcome" ], "title": "CandidateRead", "type": "object" }, "CapCounts": { "description": "What an organisation's monthly cap is weighed against.", "enum": [ "branch", "own" ], "title": "CapCounts", "type": "string" }, "CapabilityReport": { "additionalProperties": false, "description": "What the manifest needs switched on, and what this organisation is not permitted.", "properties": { "missing": { "description": "Of those, the ones this organisation's ceiling does not permit; a subscribe with any of them is refused 422", "items": { "type": "string" }, "title": "Missing", "type": "array" }, "required": { "description": "Capability names the manifest requires", "items": { "type": "string" }, "title": "Required", "type": "array" } }, "title": "CapabilityReport", "type": "object" }, "CatalogueListingRead": { "description": "One listed catalogue publication, as `GET /catalogue` returns it: the publication itself,\nand who published it -- by name as well as by id, because an id is not something a person\nchoosing an app can weigh.", "properties": { "price": { "anyOf": [ { "$ref": "#/components/schemas/TermsPrice" }, { "type": "null" } ], "description": "The price the listing shows: the `latest_version`'s, which is what a stranger installs, or for an operator the `highest_version`'s, which is the one under review; null when that version has no price" }, "publication": { "$ref": "#/components/schemas/PublicationRead", "description": "The publication itself" }, "publisher_name": { "description": "The publishing organisation's name; empty when that organisation has been erased, which a publication deliberately outlives", "title": "Publisher Name", "type": "string" } }, "required": [ "publication", "publisher_name" ], "title": "CatalogueListingRead", "type": "object" }, "Chain": { "additionalProperties": false, "description": "One primary model and the models to try instead of it, in order.", "properties": { "fallbacks": { "description": "Catalogue model ids to try instead, in order; between one and four, none equal to the primary and none repeated", "items": { "maxLength": 200, "pattern": "^[A-Za-z0-9._:/-]{1,200}$", "type": "string" }, "title": "Fallbacks", "type": "array" }, "primary": { "description": "Catalogue model id this chain is the fallback for", "maxLength": 200, "pattern": "^[A-Za-z0-9._:/-]{1,200}$", "title": "Primary", "type": "string" } }, "required": [ "primary", "fallbacks" ], "title": "Chain", "type": "object" }, "Check": { "additionalProperties": false, "description": "One rule a step's answer is held to.", "properties": { "expected": { "anyOf": [ { "maxLength": 8192, "type": "string" }, { "type": "null" } ], "description": "the author's own text: what the answer must contain, match or be judged against, or -- for `must_use_tool` -- the tool's name, null meaning any tool", "title": "Expected" }, "kind": { "description": "which rule this check applies", "enum": [ "must_use_tool", "tool_found", "exact_match", "contains_text", "not_contains", "matches_pattern", "close_match", "correct_format", "polite_tone", "no_hallucination", "response_time", "llm_judge" ], "title": "Kind", "type": "string" }, "max_match": { "anyOf": [ { "maximum": 200.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "how many characters a match of `pattern` can span at most, 1 to 200; required by `matches_pattern` alone", "title": "Max Match" }, "max_seconds": { "anyOf": [ { "exclusiveMinimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "how long the turn may take, in seconds; required by `response_time` alone", "title": "Max Seconds" }, "min_similarity": { "anyOf": [ { "maximum": 1.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "similarity ratio `close_match` passes at; 0.8 when unset, and only for it", "title": "Min Similarity" }, "pattern": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "description": "the regular expression (RE2 syntax) whose match fails the answer; required by `matches_pattern` alone, and refused when its longest match is unbounded or longer than `max_match`", "title": "Pattern" }, "required": { "default": true, "description": "whether failing this check fails its step, and so reddens the whole run", "title": "Required", "type": "boolean" }, "threshold": { "anyOf": [ { "maximum": 1.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "score a judged check passes at; 0.7 when unset, and only for a judged kind", "title": "Threshold" } }, "required": [ "kind" ], "title": "Check", "type": "object" }, "CheckResult": { "additionalProperties": false, "description": "What one check decided about one step's answer.", "properties": { "kind": { "description": "the rule that was applied", "enum": [ "must_use_tool", "tool_found", "exact_match", "contains_text", "not_contains", "matches_pattern", "close_match", "correct_format", "polite_tone", "no_hallucination", "response_time", "llm_judge" ], "title": "Kind", "type": "string" }, "outcome": { "description": "passed, failed, or errored before it could decide", "enum": [ "passed", "failed", "errored" ], "title": "Outcome", "type": "string" }, "reason": { "description": "one sentence saying why, safe to show to a reader", "title": "Reason", "type": "string" }, "required": { "description": "whether this check's failure fails its step", "title": "Required", "type": "boolean" }, "score": { "description": "how well the answer met the rule: 0 or 1 for a rule, 0..1 judged", "maximum": 1.0, "minimum": 0.0, "title": "Score", "type": "number" } }, "required": [ "kind", "required", "outcome", "score", "reason" ], "title": "CheckResult", "type": "object" }, "CheckSettings": { "additionalProperties": false, "description": "What one check is held to: a check's defaults, or an organisation's own values.", "properties": { "enabled": { "default": true, "description": "Whether the check runs", "title": "Enabled", "type": "boolean" }, "min_people": { "anyOf": [ { "maximum": 1000.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "Different people a finding must rest on; null for a check that counts none", "title": "Min People" }, "min_turns": { "description": "Turns needed before a target counts", "maximum": 100000.0, "minimum": 1.0, "title": "Min Turns", "type": "integer" }, "sample_size": { "description": "Conversations a reading reads per candidate", "maximum": 50.0, "minimum": 1.0, "title": "Sample Size", "type": "integer" }, "threshold": { "description": "The share or ratio at or above which a finding is made", "maximum": 100.0, "minimum": 0.0, "title": "Threshold", "type": "number" } }, "required": [ "threshold", "min_turns", "sample_size" ], "title": "CheckSettings", "type": "object" }, "CheckSettingsUpdate": { "additionalProperties": false, "description": "What an organisation changes about one check; a field left out keeps what it has.", "properties": { "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the check runs", "title": "Enabled" }, "min_people": { "anyOf": [ { "maximum": 1000.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "Different people a finding must rest on; only for a check that counts them (`episode_patterns`, at least 2), any other is 422", "title": "Min People" }, "min_turns": { "anyOf": [ { "maximum": 100000.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "Turns a target needs before it counts", "title": "Min Turns" }, "sample_size": { "anyOf": [ { "maximum": 50.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "Conversations a reading reads per candidate, at most 50", "title": "Sample Size" }, "threshold": { "anyOf": [ { "maximum": 100.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "The share or ratio a finding needs", "title": "Threshold" } }, "title": "CheckSettingsUpdate", "type": "object" }, "CheckSummary": { "description": "An agent's check pass rates over a window.", "properties": { "items": { "description": "One row per check name, by name", "items": { "$ref": "#/components/schemas/CheckSummaryItem" }, "title": "Items", "type": "array" }, "since": { "description": "The start of the window the counts cover", "format": "date-time", "title": "Since", "type": "string" } }, "required": [ "since", "items" ], "title": "CheckSummary", "type": "object" }, "CheckSummaryItem": { "description": "One check's results over the window.", "properties": { "errored": { "description": "Results where the check could not decide", "title": "Errored", "type": "integer" }, "failed": { "description": "Results that failed", "title": "Failed", "type": "integer" }, "name": { "description": "The check's name, as its agent version names it", "title": "Name", "type": "string" }, "passed": { "description": "Results that passed", "title": "Passed", "type": "integer" } }, "required": [ "name", "passed", "failed", "errored" ], "title": "CheckSummaryItem", "type": "object" }, "ChunkRead": { "description": "One chunk a dry run produced, without the embedding vector it may carry.", "properties": { "embedded": { "description": "Whether an `embed` node gave this chunk a vector", "title": "Embedded", "type": "boolean" }, "level": { "description": "0 = leaf; a hierarchical splitter's ancestors count up", "title": "Level", "type": "integer" }, "metadata": { "additionalProperties": true, "description": "The chunk's metadata after every node ran", "title": "Metadata", "type": "object" }, "ordinal": { "description": "0-based position among chunks at the same level", "title": "Ordinal", "type": "integer" }, "parent_ordinal": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The parent chunk's ordinal, when it has one", "title": "Parent Ordinal" }, "text": { "description": "The chunk's text", "title": "Text", "type": "string" } }, "required": [ "text", "metadata", "ordinal", "level", "parent_ordinal", "embedded" ], "title": "ChunkRead", "type": "object" }, "CitationRead": { "additionalProperties": false, "description": "One source a tool's result stands on: what kind of thing it is, and how to reach it.", "properties": { "kind": { "description": "`url` for a page a caller can open, `file` for a passage of this tenant's own indexed content", "enum": [ "url", "file" ], "title": "Kind", "type": "string" }, "ref": { "description": "the page's final URL, or the id of the chunk the passage came from", "title": "Ref", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the page's title or the knowledge source's name, when the producer recorded one", "title": "Title" } }, "required": [ "kind", "ref" ], "title": "CitationRead", "type": "object" }, "ClassifierRead": { "description": "Which classifier made a decision.", "properties": { "encoder": { "description": "The encoder and its pinned revision", "title": "Encoder", "type": "string" }, "head": { "description": "The trained head's version", "title": "Head", "type": "string" } }, "required": [ "encoder", "head" ], "title": "ClassifierRead", "type": "object" }, "ClientReport": { "additionalProperties": false, "description": "Which of the deployment's own OAuth applications the bundle names and this deployment has\nnot configured.", "properties": { "unconfigured": { "description": "Names of the deployment OAuth applications the members this configuration installs sign people in through and this deployment does not configure; a subscription with any of them waits at needs_configuration, the first named in last_error as unconfigured_client:, until the operator configures it", "items": { "type": "string" }, "title": "Unconfigured", "type": "array" } }, "title": "ClientReport", "type": "object" }, "CollectionCreate": { "additionalProperties": false, "description": "Body of `POST /knowledge/collections`.", "properties": { "description": { "default": "", "description": "Human-readable description", "maxLength": 1024, "title": "Description", "type": "string" }, "labels": { "default": {}, "description": "The organisation's classification of this collection, as label -> value; what the rules over `knowledge_collection` read. Distinct from `metadata`, which is the calling application's own map on a collection", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "additionalProperties": { "maxLength": 2048, "type": "string" }, "description": "Caller-supplied metadata", "maxProperties": 64, "propertyNames": { "maxLength": 128 }, "title": "Metadata", "type": "object" }, "name": { "description": "Collection name, unique per tenant", "maxLength": 64, "minLength": 1, "title": "Name", "type": "string" }, "retention_default": { "default": "keep", "description": "the retention a source created here takes when the caller names none; a curated collection keeps its documents, a key's own collection lets them expire", "enum": [ "window", "keep" ], "title": "Retention Default", "type": "string" } }, "required": [ "name" ], "title": "CollectionCreate", "type": "object" }, "CollectionRead": { "description": "A knowledge collection, as the API returns it.", "properties": { "connector_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The kind of connector this collection is filled by -- 'website', 'sharepoint', 'gdrive', 's3', 'zendesk' or 'fixture' -- and null for a collection filled by hand", "title": "Connector Kind" }, "created_at": { "description": "When this collection was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created the collection: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "description": { "description": "Human-readable description", "title": "Description", "type": "string" }, "id": { "description": "Knowledge collection id", "title": "Id", "type": "string" }, "key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The API key whose own collection this is -- where that key's uploads and its turns' artifacts land -- and null for a collection a caller created", "title": "Key Id" }, "labels": { "default": {}, "description": "The organisation's classification of this collection, as label -> value", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Caller-supplied metadata", "title": "Metadata", "type": "object" }, "name": { "description": "Collection name, unique per tenant", "title": "Name", "type": "string" }, "object": { "const": "knowledge_collection", "default": "knowledge_collection", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/OriginRead" }, { "type": "null" } ], "description": "The subscription that installed this collection, and the publication it came from; null for a collection this organisation made itself. A linked copy is filled by its own publication connector, so uploading into it is a 409" }, "retention_default": { "description": "the retention a source created here takes when the caller names none", "enum": [ "window", "keep" ], "title": "Retention Default", "type": "string" }, "stored_bytes": { "default": 0, "description": "Bytes this collection's sources hold now, summed from their blobs -- not a total accumulated over time", "title": "Stored Bytes", "type": "integer" }, "updated_at": { "description": "When this collection was last updated", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "name", "description", "metadata", "retention_default", "created_by", "created_at", "updated_at" ], "title": "CollectionRead", "type": "object" }, "CollectionUpdate": { "additionalProperties": false, "description": "Body of `PATCH /knowledge/collections/{id}`; absent fields are left alone.", "properties": { "description": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "Human-readable description", "title": "Description" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "new classification of this collection, replacing whatever is stored; omitted leaves it alone, and an empty map clears it", "title": "Labels" }, "metadata": { "anyOf": [ { "additionalProperties": { "maxLength": 2048, "type": "string" }, "description": "at most 64 pairs, each key at most 128 and each value at most 2048 characters", "maxProperties": 64, "propertyNames": { "maxLength": 128 }, "type": "object" }, { "type": "null" } ], "description": "Caller-supplied metadata", "title": "Metadata" }, "name": { "anyOf": [ { "maxLength": 64, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Collection name, unique per tenant", "title": "Name" }, "retention_default": { "anyOf": [ { "enum": [ "window", "keep" ], "type": "string" }, { "type": "null" } ], "description": "the retention a source created here takes when the caller names none; changing it leaves the sources already in the collection as they are", "title": "Retention Default" } }, "title": "CollectionUpdate", "type": "object" }, "Column": { "additionalProperties": false, "description": "Typed column in a record schema.", "properties": { "name": { "description": "Column name", "title": "Name", "type": "string" }, "type": { "description": "Narrowest type accepting all non-empty values", "enum": [ "boolean", "integer", "number", "date", "string" ], "title": "Type", "type": "string" } }, "required": [ "name", "type" ], "title": "Column", "type": "object" }, "CommitmentSettings": { "additionalProperties": false, "description": "How a store's commitments reach a turn.", "properties": { "inject": { "default": true, "description": "whether an injecting turn carries its person's open commitments from this store, beside the confidence-ordered records; off, a turn carries no commitment, and a fulfilled or cancelled one is never injected either way", "title": "Inject", "type": "boolean" }, "inject_limit": { "default": 10, "description": "most open commitments injected, due soonest first; the ones past it are not injected", "maximum": 50.0, "minimum": 1.0, "title": "Inject Limit", "type": "integer" } }, "title": "CommitmentSettings", "type": "object" }, "CompactionConfig": { "additionalProperties": false, "description": "The `compaction` capability: how much of a thread a model actually reads.\n\nA thread's turns, oldest first, fall into three regions -- level-1 groups, level-0 segments,\nthen the verbatim window -- and every one of the fields below is read by the one planner that\ncuts them (`app.threads.compaction_plan.plan_compaction`,\n`docs/architecture/threads.md` \"Compaction\"). A turn is one response with every item it\nadded, and is never split.\n\nThere is no `enabled` switch and no separate threshold: the capability itself is the switch,\nand the window *is* the threshold -- the first summary is made once a thread holds\n`keep_recent_turns + segment_turns` turns.", "properties": { "group_segments": { "default": 5, "description": "level-0 segments per level-1 group; read only in tiered mode", "maximum": 1000.0, "minimum": 2.0, "title": "Group Segments", "type": "integer" }, "keep_recent_turns": { "default": 5, "description": "turns at the end of the thread sent verbatim, each with every item it added; a turn is one response, its input and what the model and its tools added", "maximum": 1000.0, "minimum": 1.0, "title": "Keep Recent Turns", "type": "integer" }, "mode": { "default": "segments", "description": "window: only the window is sent and nothing is summarised; segments: the window plus one summary per complete segment before it; tiered: segments plus one level-1 summary per group of complete segments", "enum": [ "window", "segments", "tiered" ], "title": "Mode", "type": "string" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "model id used to summarise; None uses the deployment's summary model when the operator names one, else the turn's own model. Policy decides it either way, and a refusal sends the block's items verbatim", "title": "Model" }, "segment_turns": { "default": 3, "description": "whole turns per level-0 segment; a turn is never split across two", "maximum": 1000.0, "minimum": 1.0, "title": "Segment Turns", "type": "integer" }, "tool_results": { "default": "summarised", "description": "summarised: the summariser reads a segment's tool results and folds them in; omitted: it sees each tool call and one fixed Core-authored placeholder in place of each result, so a tool's output never reaches any model again once it is outside the window", "enum": [ "summarised", "omitted" ], "title": "Tool Results", "type": "string" } }, "title": "CompactionConfig", "type": "object" }, "CompactionNote": { "description": "Why this call's context was compacted the way it was, or was not compacted at all.\n\nBeside the blocks rather than inside them, because the interesting case has no block: a turn\nthat named an agent carrying a compaction configuration the calling key may not use sends its\nwhole history, and nothing in a list of injected blocks could say why\n(`docs/architecture/threads.md` \"Compaction\").", "properties": { "config_source": { "description": "whose compaction configuration this turn planned with: the calling key's own, the agent version's override of it, or none at all", "enum": [ "key", "agent", "none" ], "title": "Config Source", "type": "string" }, "mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the mode it planned in -- window, segments or tiered; null when nothing was planned", "title": "Mode" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "why nothing was planned (`key_capability_missing`, when `config_source` is none: an agent's configuration the calling key may not use), or why the plan stopped short and the rest of the history went verbatim: `summariser_refused`, `summariser_` (the call failed, such as `summariser_unknown_model`), `summariser_timeout` (the call outlasted the deployment's summary timeout), `usage_cap_reached` (a monthly cap is reached), `deadline_reached`, `left_to_thread_compact` or `member_summary_missing`", "title": "Reason" } }, "required": [ "config_source" ], "title": "CompactionNote", "type": "object" }, "ComparedRun": { "additionalProperties": false, "description": "One side of a comparison: what the run measured and its totals.", "properties": { "agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The agent measured, or null once it was deleted", "title": "Agent Id" }, "agent_name": { "description": "The agent's name as it was when the run was queued", "title": "Agent Name", "type": "string" }, "agent_version": { "description": "The agent version the run replayed against", "title": "Agent Version", "type": "integer" }, "cost": { "anyOf": [ { "$ref": "#/components/schemas/RunCost" }, { "type": "null" } ], "description": "What its turns cost; null before it concluded" }, "expired_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the retention window emptied the run's scenarios and results, or null; an expired run still has its totals but no steps to hold against another", "title": "Expired At" }, "judge_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The model that judged every check, or null when each step was judged by the model its own turn ran on", "title": "Judge Model" }, "mean_latency_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Mean turn latency in milliseconds", "title": "Mean Latency Ms" }, "mean_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Mean judged score, 0..1; null when no check was judged", "title": "Mean Score" }, "router": { "anyOf": [ { "$ref": "#/components/schemas/RunRouter" }, { "type": "null" } ], "description": "The router version its turns were routed by, or null when the agent names a model" }, "run_id": { "description": "The run", "title": "Run Id", "type": "string" }, "score": { "description": "Passed steps over total steps, as a percentage", "title": "Score", "type": "integer" } }, "required": [ "run_id", "agent_id", "agent_name", "agent_version", "router", "judge_model", "score", "mean_score", "mean_latency_ms", "cost", "expired_at" ], "title": "ComparedRun", "type": "object" }, "ComparedSide": { "additionalProperties": false, "description": "What one run did on one step.", "properties": { "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The model that answered the step's turn", "title": "Model" }, "passed": { "description": "Whether every required check of the step passed", "title": "Passed", "type": "boolean" }, "response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The turn's response, when one ran", "title": "Response Id" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Mean score of the step's judged checks, 0..1; null when none was decided", "title": "Score" } }, "required": [ "score", "model", "response_id", "passed" ], "title": "ComparedSide", "type": "object" }, "ComparedStep": { "additionalProperties": false, "description": "One step as the two runs fared on it.", "properties": { "against": { "anyOf": [ { "$ref": "#/components/schemas/ComparedSide" }, { "type": "null" } ], "description": "The second run's result, null when it has none" }, "outcome": { "description": "How the first run fared against the second", "enum": [ "win", "tie", "loss", "unscored" ], "title": "Outcome", "type": "string" }, "run": { "anyOf": [ { "$ref": "#/components/schemas/ComparedSide" }, { "type": "null" } ], "description": "The first run's result, null when it has none" }, "scenario_id": { "description": "The scenario the step belongs to", "title": "Scenario Id", "type": "string" }, "step_id": { "description": "The step", "title": "Step Id", "type": "string" } }, "required": [ "scenario_id", "step_id", "run", "against", "outcome" ], "title": "ComparedStep", "type": "object" }, "ComputerConfig": { "additionalProperties": false, "description": "The `computer` capability: an isolated machine a turn may run commands on and move files in\nand out of, through the computer tools (`docs/architecture/computers.md`).\n\nOne dependency, `tooling`: the computer is reached through builtin tools, and the key must\nalso name `computer` in `ToolingConfig.system_tools` -- the opt-in every builtin answers to.\nFiles reach a computer only for a key that also holds `files`, and leave it as artifacts only\nfor one that holds `artifacts`. Every field narrows the deployment's own limit and none can\nwiden it: `None` takes the deployment's (`app.computers.terms.terms_for`).", "properties": { "disk_mb": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "scratch disk a computer is made with, in megabytes; None uses the deployment's computer_disk_mb, and a larger value is cut to it", "title": "Disk Mb" }, "exec_timeout_seconds": { "anyOf": [ { "exclusiveMinimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "description": "longest one command may run; None uses the deployment's computer_exec_timeout_seconds, and a longer value is cut to it", "title": "Exec Timeout Seconds" }, "lifetime_seconds": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "longest a computer may live; None uses the deployment's computer_lifetime_seconds, and a longer value is cut to it", "title": "Lifetime Seconds" } }, "title": "ComputerConfig", "type": "object" }, "ComputerEgressObject": { "description": "One connection a computer opened through Core's egress proxy: where to, how many bytes, and\nhow it ended. Never content -- no path, no header, no byte of what crossed.", "properties": { "bytes_in": { "description": "Bytes the host sent back", "title": "Bytes In", "type": "integer" }, "bytes_out": { "description": "Bytes the computer sent to the host", "title": "Bytes Out", "type": "integer" }, "closed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the connection ended; null while a long one is still open", "title": "Closed At" }, "computer_id": { "description": "The computer that opened it", "title": "Computer Id", "type": "string" }, "host": { "description": "The host asked for, in its canonical spelling", "title": "Host", "type": "string" }, "id": { "description": "Connection id", "title": "Id", "type": "string" }, "key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The key whose turn made the computer", "title": "Key Id" }, "object": { "const": "computer_egress", "default": "computer_egress", "description": "Always 'computer_egress'", "title": "Object", "type": "string" }, "opened_at": { "description": "When the proxy read the computer's request", "format": "date-time", "title": "Opened At", "type": "string" }, "outcome": { "description": "'allowed' when let through; 'blocked' by the deployment's block list; 'denied' by the organisation's or the key's rules; 'rate_limited' by the organisation's share of the proxy, at the start or once its bytes ran past it; 'address_refused' when the host resolved to an address Core never dials; 'dial_failed' when it was allowed and the destination could not be reached; 'revoked' when it was closed while it ran because the computer, its key or its organisation no longer allowed it, or the host no longer was", "enum": [ "allowed", "blocked", "denied", "rate_limited", "address_refused", "dial_failed", "revoked" ], "title": "Outcome", "type": "string" }, "port": { "description": "The port asked for: 443 or 80", "title": "Port", "type": "integer" } }, "required": [ "id", "computer_id", "key_id", "host", "port", "bytes_out", "bytes_in", "outcome", "opened_at", "closed_at" ], "title": "ComputerEgressObject", "type": "object" }, "ComputerObject": { "description": "One computer an organisation's turn made.", "properties": { "compute_ref": { "description": "The compute pool it runs on", "title": "Compute Ref", "type": "string" }, "created_at": { "description": "When it was asked for", "format": "date-time", "title": "Created At", "type": "string" }, "ended_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When it was destroyed or failed", "title": "Ended At" }, "held_until": { "description": "Until when the work that made it holds it; past this and a grace, the worker destroys it", "format": "date-time", "title": "Held Until", "type": "string" }, "id": { "description": "Computer id", "title": "Id", "type": "string" }, "key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The key whose turn made it, its usage billed to", "title": "Key Id" }, "object": { "const": "computer", "default": "computer", "description": "Always 'computer'", "title": "Object", "type": "string" }, "provider": { "description": "Which provider runs it: 'local_test' or 'northflank'", "title": "Provider", "type": "string" }, "ready_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When it first accepted commands", "title": "Ready At" }, "response_id": { "description": "The response whose turn made this computer", "title": "Response Id", "type": "string" }, "scope": { "const": "run", "description": "How long it is meant to live: 'run', one response", "title": "Scope", "type": "string" }, "status": { "description": "'starting' while the provider makes it, 'ready' while it accepts commands, 'destroyed' once gone, 'failed' when it could not be made", "enum": [ "starting", "ready", "stopped", "destroyed", "failed" ], "title": "Status", "type": "string" } }, "required": [ "id", "response_id", "key_id", "scope", "compute_ref", "provider", "status", "held_until", "created_at", "ready_at", "ended_at" ], "title": "ComputerObject", "type": "object" }, "ConnectorPatch": { "additionalProperties": false, "description": "Body of `PATCH /knowledge/collections/{id}/connector`; absent fields are left alone.\n\n`config` is validated against the *stored* `kind` -- a connector never changes kind; replace\nit with a `PUT` instead. A secret field present in `config` rotates that secret; one absent\nleaves the sealed credentials as they are.", "properties": { "config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Replacement settings, of this connector's own kind", "title": "Config" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "new opaque document, replacing whatever is stored whole; omitted leaves it alone, and {} clears it", "title": "Metadata" }, "schedule_cron": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "type": "null" } ], "description": "New cron expression; an explicit null clears it. Switching from `schedule_minutes` to this needs both fields in the same call, `schedule_minutes: null` included -- the service refuses a connector left with both", "title": "Schedule Cron" }, "schedule_minutes": { "anyOf": [ { "maximum": 44640.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "Minutes between scheduled syncs; an explicit null makes it manual only", "title": "Schedule Minutes" }, "schedule_timezone": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "New IANA zone `schedule_cron` is read in", "title": "Schedule Timezone" } }, "title": "ConnectorPatch", "type": "object" }, "ConnectorPut": { "additionalProperties": false, "description": "Body of `PUT /knowledge/collections/{id}/connector`: the whole connector, created or\nreplaced. A secret field left out of a replace clears that secret, exactly as leaving out\nany other field resets it -- `PATCH` is what changes one field and keeps the rest.", "properties": { "config": { "description": "The connector's own settings, by `kind`", "discriminator": { "mapping": { "conversations": "#/components/schemas/ConversationsConnectorConfig", "fixture": "#/components/schemas/FixtureConnectorConfig", "gdrive": "#/components/schemas/GoogleDriveConnectorConfig", "publication": "#/components/schemas/PublicationConnectorConfig", "s3": "#/components/schemas/S3ConnectorConfig", "sharepoint": "#/components/schemas/SharePointConnectorConfig", "website": "#/components/schemas/WebsiteConnectorConfig", "zendesk": "#/components/schemas/ZendeskConnectorConfig" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/WebsiteConnectorConfig" }, { "$ref": "#/components/schemas/SharePointConnectorConfig" }, { "$ref": "#/components/schemas/GoogleDriveConnectorConfig" }, { "$ref": "#/components/schemas/S3ConnectorConfig" }, { "$ref": "#/components/schemas/ZendeskConnectorConfig" }, { "$ref": "#/components/schemas/FixtureConnectorConfig" }, { "$ref": "#/components/schemas/PublicationConnectorConfig" }, { "$ref": "#/components/schemas/ConversationsConnectorConfig" } ], "title": "Config" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the connector, at most 16 KiB serialised: stored, returned and never read by Core; omitted or null stores {}", "title": "Metadata" }, "schedule_cron": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "type": "null" } ], "description": "Five-field cron expression -- minute hour day-of-month month day-of-week -- read in `schedule_timezone`; mutually exclusive with `schedule_minutes`", "title": "Schedule Cron" }, "schedule_minutes": { "anyOf": [ { "maximum": 44640.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "Minutes between scheduled syncs; null means this connector syncs only when a caller asks it to; mutually exclusive with `schedule_cron`", "title": "Schedule Minutes" }, "schedule_timezone": { "default": "UTC", "description": "IANA zone name `schedule_cron` is read in; ignored while it is null", "maxLength": 64, "title": "Schedule Timezone", "type": "string" } }, "required": [ "config" ], "title": "ConnectorPut", "type": "object" }, "ConnectorRead": { "description": "A connector, as the API returns it. It has no credentials field at all: `has_credentials`\nsays whether the row carries sealed bytes, and nothing else about them is ever readable.", "properties": { "collection_id": { "description": "The collection this connector fills", "title": "Collection Id", "type": "string" }, "config": { "additionalProperties": true, "description": "The connector's non-secret settings", "title": "Config", "type": "object" }, "created_at": { "description": "When this connector was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created the connector: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "egress": { "description": "The host this connector dials when `config` names one (an S3 `endpoint_url`), with whether the organisation's allowed hosts permit it and whether the deployment blocks it, as of this read. A host that is not allowed, or is blocked, is refused at every sync; an administrator adds it under the organisation's allowed hosts. Empty for a connector that names no host of its own", "items": { "$ref": "#/components/schemas/HostAccess" }, "title": "Egress", "type": "array" }, "has_credentials": { "description": "Whether a secret is stored for this connector", "title": "Has Credentials", "type": "boolean" }, "id": { "description": "Knowledge connector id", "title": "Id", "type": "string" }, "kind": { "description": "Which system this connector pulls from", "enum": [ "website", "sharepoint", "gdrive", "s3", "zendesk", "fixture", "publication", "conversations" ], "title": "Kind", "type": "string" }, "last_error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Fixed failure code of the last run, if any", "title": "Last Error Code" }, "last_synced_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When its last run finished", "title": "Last Synced At" }, "metadata": { "additionalProperties": true, "default": {}, "description": "The opaque document attached to this connector; {} when none was set", "title": "Metadata", "type": "object" }, "object": { "const": "knowledge_connector", "default": "knowledge_connector", "description": "The object's type", "title": "Object", "type": "string" }, "schedule_cron": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Five-field cron expression this connector syncs on; null when it does not", "title": "Schedule Cron" }, "schedule_minutes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Minutes between scheduled syncs; null means manual only", "title": "Schedule Minutes" }, "schedule_timezone": { "description": "IANA zone `schedule_cron` is read in", "title": "Schedule Timezone", "type": "string" }, "status": { "description": "This connector's state", "enum": [ "idle", "syncing", "failed" ], "title": "Status", "type": "string" }, "updated_at": { "description": "When this connector was last updated", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "collection_id", "kind", "config", "has_credentials", "schedule_minutes", "schedule_cron", "schedule_timezone", "status", "last_synced_at", "last_error_code", "created_by", "created_at", "updated_at" ], "title": "ConnectorRead", "type": "object" }, "ConnectorTestRead": { "description": "The answer of `POST .../connector/test`: a bounded connectivity check that lists at most\none item and stores nothing.", "properties": { "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Fixed failure code when it did not; never a provider's own message", "title": "Error Code" }, "object": { "const": "knowledge_connector_test", "default": "knowledge_connector_test", "description": "The object's type", "title": "Object", "type": "string" }, "ok": { "description": "Whether the connector reached its system and listed something", "title": "Ok", "type": "boolean" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "One fixed sentence saying what `error_code` means; null when the check succeeded", "title": "Reason" }, "sample_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The one item the check listed, when it listed one", "title": "Sample Uri" } }, "required": [ "ok" ], "title": "ConnectorTestRead", "type": "object" }, "ContextElement": { "description": "One element of the context, in the order it was sent.", "properties": { "authority": { "description": "whose words these are: core, developer, delegate, user or model", "title": "Authority", "type": "string" }, "characters": { "description": "how long this element's rendered text is, in characters", "title": "Characters", "type": "integer" }, "index": { "description": "position in the assembled context, counted from zero", "title": "Index", "type": "integer" }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the row this element came from -- a thread item, a memory record, a skill -- when it came from one. The first of `source_ids`, kept beside it because an element with exactly one row behind it is the ordinary case", "title": "Source Id" }, "source_ids": { "description": "every row behind this element, in order. More than one only for a model round, which is several items -- what the model thought, what it said, every call it asked for -- sent as a single message; empty for an element no row produced", "items": { "type": "string" }, "title": "Source Ids", "type": "array" }, "source_kind": { "description": "what put this element in the context", "enum": [ "preamble", "instruction", "hoisted_instruction", "item", "memory", "skill", "summary", "tool_result", "notice" ], "title": "Source Kind", "type": "string" }, "text_ref": { "description": "where the text of this element is in the recorded request, as a JSON pointer into `request.body`; empty when Core could not place it", "title": "Text Ref", "type": "string" }, "tool_calls": { "description": "the tool calls this element asked for, in the order the model made them; empty for every element that asked for none", "items": { "$ref": "#/components/schemas/ElementToolCall" }, "title": "Tool Calls", "type": "array" }, "trust": { "description": "whether the content could be vouched for: trusted or untrusted", "title": "Trust", "type": "string" } }, "required": [ "index", "authority", "trust", "source_kind", "text_ref", "characters" ], "title": "ContextElement", "type": "object" }, "ControlEventRead": { "description": "One control-plane event, as the operator control-events API returns it.", "properties": { "actor": { "description": "The acting key's id, or 'operator:' for a human management action (an operator's, or a tenant admin's on its own tenant)", "title": "Actor", "type": "string" }, "attempts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "How many identical attempts this refusal row stands for: a refusal repeated inside one coalescing window is written once and counted here, its first attempt included. Null for every row that is not a coalesced refusal, each of which is one event", "title": "Attempts" }, "created_at": { "description": "When this event was recorded", "format": "date-time", "title": "Created At", "type": "string" }, "event": { "description": "Event name", "title": "Event", "type": "string" }, "id": { "description": "Control event id", "title": "Id", "type": "string" }, "key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Key that caused this event; null for an operator action", "title": "Key Id" }, "object": { "const": "control_event", "default": "control_event", "description": "The object's type", "title": "Object", "type": "string" }, "refs": { "additionalProperties": true, "description": "Ids, names and labels this event references", "title": "Refs", "type": "object" }, "request_id": { "description": "Id of the request that caused this event", "title": "Request Id", "type": "string" }, "span_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Span within that trace; null when the deployment exports no telemetry", "title": "Span Id" }, "tenant_id": { "description": "Tenant this event is about", "title": "Tenant Id", "type": "string" }, "trace_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Trace this event was recorded in; null when the deployment exports no telemetry", "title": "Trace Id" } }, "required": [ "id", "tenant_id", "key_id", "actor", "request_id", "trace_id", "span_id", "event", "refs", "created_at" ], "title": "ControlEventRead", "type": "object" }, "Conversation": { "additionalProperties": false, "description": "The conversation a stored turn belongs to: Core's thread, under the vendor's name.", "properties": { "id": { "description": "the thread this response's items were stored on", "title": "Id", "type": "string" } }, "required": [ "id" ], "title": "Conversation", "type": "object" }, "ConversationFilters": { "additionalProperties": false, "description": "Which of the organisation's threads a `conversations` connector reads, and in what pieces;\nthe extraction switch of a memory store writes the same fields\n(`docs/architecture/knowledge-and-memory.md` \"Memory extraction\").", "properties": { "agent_ids": { "description": "Only threads on which a turn ran one of these agents; empty reads every agent's. A thread must pass this and `key_ids` both", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "maxItems": 100, "title": "Agent Ids", "type": "array" }, "key_ids": { "description": "Only threads these keys created are read; empty reads every key's", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "maxItems": 100, "title": "Key Ids", "type": "array" }, "lookback_days": { "default": 30, "description": "Only threads that gained a message within this many days are offered; an older thread's windows leave the collection, and what was extracted from them stays", "maximum": 3650.0, "minimum": 1.0, "title": "Lookback Days", "type": "integer" }, "min_items": { "default": 2, "description": "A thread with fewer messages than this is not read at all", "maximum": 1000.0, "minimum": 1.0, "title": "Min Items", "type": "integer" }, "settle_minutes": { "default": 30, "description": "Minutes a thread must have been idle before it is read, so a conversation still going on is never read mid-turn", "maximum": 10080.0, "minimum": 1.0, "title": "Settle Minutes", "type": "integer" }, "window_items": { "default": 40, "description": "Messages per source: a thread is read in windows of this many, so a growing thread re-reads only its last window", "maximum": 200.0, "minimum": 5.0, "title": "Window Items", "type": "integer" } }, "title": "ConversationFilters", "type": "object" }, "ConversationRef": { "additionalProperties": false, "description": "A conversation named as an object, which is how the Responses API names one.", "properties": { "id": { "description": "the thread this turn continues", "title": "Id", "type": "string" } }, "required": [ "id" ], "title": "ConversationRef", "type": "object" }, "ConversationsConnectorConfig": { "additionalProperties": false, "description": "This organisation's own threads, one source per window of a settled thread's messages and,\nwith `sessions`, one per part of each session an idle gap ended\n(`docs/architecture/knowledge-and-memory.md` \"Memory extraction\", \"Episodes\"). No credential\nand no network: the provider reads the organisation's own database on the worker.", "properties": { "agent_ids": { "description": "Only threads on which a turn ran one of these agents; empty reads every agent's. A thread must pass this and `key_ids` both", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "maxItems": 100, "title": "Agent Ids", "type": "array" }, "exclude_path_regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Items whose path matches this are skipped, on top of the built-in media/binary exclusion, which always applies and is never replaced", "title": "Exclude Path Regex" }, "include_path_regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Only items whose path matches this are synced; null matches all", "title": "Include Path Regex" }, "key_ids": { "description": "Only threads these keys created are read; empty reads every key's", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "maxItems": 100, "title": "Key Ids", "type": "array" }, "kind": { "const": "conversations", "description": "Connector kind", "title": "Kind", "type": "string" }, "lookback_days": { "default": 30, "description": "Only threads that gained a message within this many days are offered; an older thread's windows leave the collection, and what was extracted from them stays", "maximum": 3650.0, "minimum": 1.0, "title": "Lookback Days", "type": "integer" }, "min_items": { "default": 2, "description": "A thread with fewer messages than this is not read at all", "maximum": 1000.0, "minimum": 1.0, "title": "Min Items", "type": "integer" }, "session_items": { "default": 200, "description": "Most messages one source of a session holds; a longer session is read in consecutive parts, each also cut at about 30,000 bytes", "maximum": 200.0, "minimum": 5.0, "title": "Session Items", "type": "integer" }, "sessions": { "default": false, "description": "Also offer each settled session -- the messages up to an idle gap longer than `settle_minutes` -- as sources of its own, beside the windows; what a memory store's episodes read", "title": "Sessions", "type": "boolean" }, "sessions_since": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Only sessions that settled after this time are offered; null offers every session the other filters admit", "title": "Sessions Since" }, "settle_minutes": { "default": 30, "description": "Minutes a thread must have been idle before it is read, so a conversation still going on is never read mid-turn", "maximum": 10080.0, "minimum": 1.0, "title": "Settle Minutes", "type": "integer" }, "threads": { "default": "all", "description": "Which threads are read: `with_person` only those that name a person, `all` every settled thread. A thread for nobody is the organisation's own, so mining it would write a person's private fact as one every colleague is shown; the memory extraction switch asks for `with_person` unless the organisation says otherwise", "enum": [ "with_person", "all" ], "title": "Threads", "type": "string" }, "window_items": { "default": 40, "description": "Messages per source: a thread is read in windows of this many, so a growing thread re-reads only its last window", "maximum": 200.0, "minimum": 5.0, "title": "Window Items", "type": "integer" } }, "required": [ "kind" ], "title": "ConversationsConnectorConfig", "type": "object" }, "CoreToolIn": { "additionalProperties": false, "description": "One tool of the tenant's catalogue, by qualified name -- this surface's extension for a\ntool **Core** runs (`GET /tools` lists them).", "properties": { "name": { "description": "the tool's qualified name", "maxLength": 64, "title": "Name", "type": "string" }, "type": { "const": "core_tool", "default": "core_tool", "description": "tool kind", "title": "Type", "type": "string" }, "version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "pinned version of an `api__` connector; latest when unset", "title": "Version" } }, "required": [ "name" ], "title": "CoreToolIn", "type": "object" }, "CoreToolsetIn": { "additionalProperties": false, "description": "One of the tenant's toolsets, by name -- this surface's extension for a group of tools\nCore runs.", "properties": { "name": { "description": "the toolset's name", "maxLength": 64, "title": "Name", "type": "string" }, "type": { "const": "core_toolset", "default": "core_toolset", "description": "tool kind", "title": "Type", "type": "string" } }, "required": [ "name" ], "title": "CoreToolsetIn", "type": "object" }, "CoverRead": { "description": "One cover, as every read model that can carry one answers it.\n\n`from` says where the picture came from, so a console knows which `…/cover` route to ask for\nthe bytes: `own` is the route of the thing being read, `source` is the MCP server's.", "properties": { "content_type": { "description": "The image type the stored bytes are: image/png, image/jpeg or image/webp", "title": "Content Type", "type": "string" }, "from": { "default": "own", "description": "'own' when this cover was set on the thing being read, 'source' when it is the MCP server's own cover standing in for one of its tools", "enum": [ "own", "source" ], "title": "From", "type": "string" }, "object": { "const": "cover", "default": "cover", "description": "The object's type", "title": "Object", "type": "string" }, "sha256": { "description": "Hex sha256 of the image, which is the ETag its own `GET .../cover` answers", "title": "Sha256", "type": "string" }, "size_bytes": { "description": "How many bytes the image holds", "title": "Size Bytes", "type": "integer" }, "updated_at": { "description": "When this cover was last replaced", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "content_type", "size_bytes", "sha256", "updated_at" ], "title": "CoverRead", "type": "object" }, "CreateResponseRequest": { "additionalProperties": false, "description": "A Responses-compatible request to create one turn.\n\n**A field the vendor declares and Core does not act on is one of three things.** A hint that\ndoes not change what the answer means (`service_tier`, `include`, `prompt_cache_key`,\n`client_metadata`, `safety_identifier`, `text.verbosity`) is accepted and ignored: declared,\nnever forwarded, stored or answered back. A field a provider can take is honoured: `top_p`,\n`parallel_tool_calls`, a `tool_choice` naming one function, and `reasoning.generate_summary`,\nwhich is `summary`. A field whose value a 200 would misrepresent -- `truncation: \"auto\"`,\nany other `tool_choice` object and a server tool type Core does not run -- is a `422`\nnaming the field. `extra=\"forbid\"`\nstill refuses a field no vendor declares (`docs/architecture/responses.md`).", "properties": { "agent": { "anyOf": [ { "$ref": "#/components/schemas/AgentRef" }, { "type": "null" } ], "description": "a stored agent this turn is built on (Core extension): its definition is combined with this request before anything else is resolved, adding to `skills` and `tools`, adding its instruction after the request's own, and running on its own value of every other field it fixes. Required under a key whose policy sets `settings.agents_required`: a turn naming none, or adding `tools`, `skills`, `instructions` or a `prompt` of its own, is refused with 403" }, "background": { "default": false, "description": "run this turn asynchronously; requires store", "title": "Background", "type": "boolean" }, "callback_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https?://", "type": "string" }, { "type": "null" } ], "description": "webhook notified when a background run completes, decided as every destination an organisation chooses is: refused 403 when it is an address on a private network, when the deployment blocks the host, when the organisation's allowed hosts or this key's own rules over `egress_host` do not permit it, or, for a key whose policy names regions_allow, when host_regions does not place the host in one of them and no residency exception names it", "title": "Callback Url" }, "callback_vendor": { "anyOf": [ { "$ref": "#/components/schemas/VendorOrigin" }, { "type": "null" } ], "description": "who runs `callback_url`'s host, as you state it: where the company serving it and its ultimate parent are established, each a zone ('eu', 'us', 'global') or an ISO 3166-1 alpha-2 country code. A key or organisation whose `policy.settings.vendors_allow` names places reaches the callback only when they contain what is stated, at create and again at delivery; a fact left out is 'global'" }, "client_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "free keys a client attaches for itself; accepted and ignored: a hint that does not change what the answer means, so Core never forwards it, stores it or answers it back", "title": "Client Metadata" }, "conversation": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/ConversationRef" }, { "type": "null" } ], "description": "the conversation this turn belongs to, as an id or as `{\"id\"}`: the Responses API's own name for what Core calls a thread, and the same thing as `thread_id`. Mutually exclusive with `thread_id` and `previous_response_id`", "title": "Conversation" }, "cost_limit_eur": { "anyOf": [ { "exclusiveMinimum": 0.0, "maximum": 1000000.0, "type": "number" }, { "pattern": "^\\d{1,7}(\\.\\d{1,6})?$", "type": "string" }, { "type": "null" } ], "description": "the most this background run, the agent tasks it starts and their runs may spend, in euro: above zero, at most 1000000, at most six decimals; reached, the run ends incomplete with reason `cost_limit`. A Core extension; requires background", "title": "Cost Limit Eur" }, "helper": { "anyOf": [ { "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*){1,3}$", "type": "string" }, { "type": "null" } ], "description": "the caller's own helper this turn is the work of (Core extension): two to four dotted lowercase segments, at most 64 characters, such as `acme.summary`; `assist.` is Core's own. Every usage row the turn writes names it and its model calls are traced under it as their job. Without `model`, and with no agent fixing one, the turn runs on the organisation's helper model, and is refused with 409 as a helper call is where there is none. Nothing else changes: the key's policy, caps and tools decide as for any turn", "title": "Helper" }, "hosting": { "anyOf": [ { "$ref": "#/components/schemas/HostingRequirement" }, { "type": "null" } ], "description": "where the model answering this turn must run (Core extension); a background run keeps the requirement it was created under" }, "include": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "extra fields the vendor can add to an item; accepted and ignored: a hint that does not change what the answer means, so Core never forwards it, stores it or answers it back. Every field Core answers is answered always (`docs/architecture/responses.md`)", "title": "Include" }, "input": { "anyOf": [ { "type": "string" }, { "items": { "discriminator": { "mapping": { "custom_tool_call": "#/components/schemas/CustomToolCallInput", "custom_tool_call_output": "#/components/schemas/CustomToolCallOutputInput", "function_call": "#/components/schemas/FunctionCallInput", "function_call_output": "#/components/schemas/FunctionCallOutputInput", "message": "#/components/schemas/MessageInput", "reasoning": "#/components/schemas/ReasoningInput" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/MessageInput" }, { "$ref": "#/components/schemas/FunctionCallInput" }, { "$ref": "#/components/schemas/FunctionCallOutputInput" }, { "$ref": "#/components/schemas/CustomToolCallInput" }, { "$ref": "#/components/schemas/CustomToolCallOutputInput" }, { "$ref": "#/components/schemas/ReasoningInput" } ] }, "type": "array" } ], "default": [], "description": "the turn's input items, or the text of one user message, at most 1 MiB", "title": "Input" }, "instructions": { "anyOf": [ { "maxLength": 262144, "type": "string" }, { "type": "null" } ], "description": "a standing developer instruction, at most 262144 characters", "title": "Instructions" }, "labels": { "default": {}, "description": "labels the rules over this row's kind read, as label -> a value or a list of 1 to 32 distinct values, each of 1 to 256 characters; at most 32 names. Held to the organisation's vocabulary and, for a request naming a person, to `writable_labels`. The thread a turn opens carries them; a turn on an existing thread starts with that thread's labels, and these add to or change them", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "max_output_tokens": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "ceiling on generated output tokens", "title": "Max Output Tokens" }, "max_tool_rounds": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "ceiling on tool rounds for this turn; also bounded by settings", "title": "Max Tool Rounds" }, "metadata": { "default": {}, "description": "caller-supplied key/value pairs, at most 16", "maxProperties": 16, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "maxLength": 512, "type": "string" } }, "title": "Metadata", "type": "object" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "catalogue model id to run this turn against, or an agent to build it on: `agent:` or the agent's `agt_` id, as `GET /models` lists them -- the same reference `agent` makes, for a client that can only name a model, and refused with 422 for an agent that fixes no model. Optional only when `agent` names an agent version that fixes one, or `helper` names a helper, which runs on the organisation's helper model; a request with none of these is refused on `model`", "title": "Model" }, "parallel_tool_calls": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "whether the model may ask for several tools in one round. Left out, the provider is told nothing and its own default applies; `false` asks it for one call a round, and is refused with a 400 naming it on a model whose provider has no way to say so (Gemini). Core still runs whatever calls one round asks for together", "title": "Parallel Tool Calls" }, "previous_response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "continue the thread that produced this response", "title": "Previous Response Id" }, "prompt": { "anyOf": [ { "$ref": "#/components/schemas/PromptRef" }, { "type": "null" } ], "description": "a stored prompt to render as input" }, "prompt_cache_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the vendor's cache routing key; accepted and ignored: a hint that does not change what the answer means, so Core never forwards it, stores it or answers it back. Core chooses its own cache prefix, and one provider account serves every tenant, so a caller's key never reaches it", "title": "Prompt Cache Key" }, "reasoning": { "anyOf": [ { "$ref": "#/components/schemas/ReasoningParam" }, { "type": "null" } ], "description": "what this turn asks of the model's own thinking: how hard to think, and whether to return a readable summary of it" }, "routing_config_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "the routing configuration this turn falls over along instead of its agent's and the key's, one of the organisation's, published; the key's switch off overrides it", "title": "Routing Config Id" }, "safety_identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the vendor's stable id of the end user; accepted and ignored: a hint that does not change what the answer means, so Core never forwards it, stores it or answers it back. It identifies a person, and a subject id is stored on the tenant's own rows and on nothing that leaves the process, so it is never forwarded (`user` names the subject)", "title": "Safety Identifier" }, "service_tier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the vendor's processing tier; accepted and ignored: a hint that does not change what the answer means, so Core never forwards it, stores it or answers it back. A deployment's providers are what its catalogue configures, and a caller cannot buy a different one per request", "title": "Service Tier" }, "skills": { "default": [], "description": "skill names or ids to offer, each the skill's latest version, or `name@3` for version 3", "items": { "type": "string" }, "maxItems": 32, "title": "Skills", "type": "array" }, "store": { "default": true, "description": "persist this turn when threads are effective", "title": "Store", "type": "boolean" }, "stream": { "default": false, "description": "answer Server-Sent Events as the turn happens; not with background", "title": "Stream", "type": "boolean" }, "task_wake": { "default": true, "description": "whether the result of a task this turn starts, when it arrives after the turn has ended, starts a background turn on the thread to answer it; false leaves the result on the thread for the next turn. A Core extension, read only where the key holds `tasks`", "title": "Task Wake", "type": "boolean" }, "temperature": { "anyOf": [ { "maximum": 2.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "sampling temperature", "title": "Temperature" }, "text": { "anyOf": [ { "$ref": "#/components/schemas/TextFormat" }, { "type": "null" } ], "description": "the required output text format" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "continue this thread (Core extension); mutually exclusive with previous_response_id and conversation", "title": "Thread Id" }, "timezone": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "the IANA zone a prompt's time values -- `date`, `time`, `datetime`, `weekday` -- are read in for this turn; null reads them in the firing schedule's zone, else the organisation's own `timezone`, else UTC (Core extension)", "title": "Timezone" }, "tool_approval": { "anyOf": [ { "$ref": "#/components/schemas/ToolApprovalOption" }, { "type": "null" } ], "description": "park tool calls until `POST /responses/{id}/approvals/{approval_id}` decides each, by a mode per tool: `always` parks, `never` runs, `model` parks what the model marks with `request_approval`. Unlisted tools take `default`, which is `never`, so `{}` parks only calls of agent tools and `builtin__subagent`; send `{\"default\": \"model\"}` to let the model decide for every tool, as `{}` did before. A Core extension; requires background" }, "tool_choice": { "anyOf": [ { "enum": [ "auto", "none", "required" ], "type": "string" }, { "$ref": "#/components/schemas/ToolChoiceFunction" } ], "default": "auto", "description": "how the model may use the offered tools: `auto`, `none`, `required`, or `{\"type\": \"function\", \"name\"}` naming the one tool it must call. `required` and a named tool bind the turn's first model call; a later round of the same turn, after a tool ran, is `auto` so the model may answer. A named tool must be one this turn offers after policy -- naming it never makes a tool available -- and every other object shape the vendor declares (`allowed_tools`, a hosted tool type, `mcp`, `custom`) is refused by name", "title": "Tool Choice" }, "tool_search": { "anyOf": [ { "$ref": "#/components/schemas/ToolSearchParam" }, { "type": "null" } ], "description": "whether this turn offers its server tools directly or behind the tool router (Core extension): `router` offers `builtin__tool_search` and `builtin__tool_run` in their place and needs the key's `tooling.tool_search.enabled`. It wins over the agent's own choice; null takes the agent's, then the key's default. A `tools` entry of type `tool_search`, or `defer_loading: true` on any entry, asks for `router` on the whole call where this is null" }, "tool_variables": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Values for the call variables the tools of this turn declare, as a flat object of names to strings, numbers or booleans. Never shown to the model and never echoed: each tool receives only the variables it declares, checked against its declaration before the model is called (422 on tool_variables., naming the tool); a name no tool declares is ignored. A nested agent, a subagent and a task inherit them. At most `tool_variables_max_names` names, `tool_variables_max_string_chars` characters in one string and `tool_variables_max_bytes` bytes in all", "propertyNames": { "maxLength": 64, "minLength": 1 }, "title": "Tool Variables", "type": "object" }, "tools": { "default": [], "description": "tools offered this turn, at most 128, each tool of a `namespace` counted on its own", "items": { "discriminator": { "mapping": { "agent": "#/components/schemas/AgentAsToolParam", "custom": "#/components/schemas/CustomToolParam", "function": "#/components/schemas/FunctionToolParam", "namespace": "#/components/schemas/NamespaceToolParam", "tool": "#/components/schemas/ToolReferenceParam", "toolset": "#/components/schemas/ToolsetToolParam", "web_search": "#/components/schemas/WebSearchToolParam", "web_search_2025_08_26": "#/components/schemas/WebSearchToolParam", "web_search_preview": "#/components/schemas/WebSearchToolParam", "web_search_preview_2025_03_11": "#/components/schemas/WebSearchToolParam", "workflow": "#/components/schemas/WorkflowToolParam" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/FunctionToolParam" }, { "$ref": "#/components/schemas/CustomToolParam" }, { "$ref": "#/components/schemas/NamespaceToolParam" }, { "$ref": "#/components/schemas/ToolReferenceParam" }, { "$ref": "#/components/schemas/ToolsetToolParam" }, { "$ref": "#/components/schemas/AgentAsToolParam" }, { "$ref": "#/components/schemas/WorkflowToolParam" }, { "$ref": "#/components/schemas/WebSearchToolParam" } ] }, "maxItems": 128, "title": "Tools", "type": "array" }, "top_p": { "anyOf": [ { "maximum": 1.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "nucleus sampling: the probability mass the model samples from. Sent to the provider under its own name. Refused with a 400 naming it on a model the operator declared without `temperature`, whose vendor fixed its sampling", "title": "Top P" }, "truncation": { "anyOf": [ { "enum": [ "auto", "disabled" ], "type": "string" }, { "type": "null" } ], "description": "`disabled` is what Core does and the only value it accepts; `auto` is refused, because Core never drops context to make a call fit -- a context that does not fit is a failed turn, or a shorter one through `compaction`", "title": "Truncation" }, "user": { "anyOf": [ { "pattern": "^[A-Za-z0-9._:@-]{1,128}$", "type": "string" }, { "type": "null" } ], "description": "the calling application's own opaque identifier of the person this turn is for -- never a name, an address or anything else about them. It is what a tool authenticating as that person resolves its stored grant by (Core extension)", "title": "User", "x-core-subject-alias": true }, "working_state_from": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "start the thread this request creates with a copy of this thread's working state (Core extension): one of the same named person's threads; refused on a request that continues a thread or stores none", "title": "Working State From" } }, "title": "CreateResponseRequest", "type": "object" }, "CustomToolCallInput": { "additionalProperties": false, "description": "A `custom_tool_call` replayed on the request: the model's own prior call on a custom\n(freeform) tool, whose argument is one free text rather than a JSON object.", "properties": { "call_id": { "description": "id correlating this call with its custom_tool_call_output", "maxLength": 128, "minLength": 1, "title": "Call Id", "type": "string" }, "caller": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the context that produced the call; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Caller" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the item's id; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Id" }, "input": { "description": "the call's free-text input, as emitted", "maxLength": 1048576, "title": "Input", "type": "string" }, "name": { "description": "the custom tool that was called", "pattern": "^[A-Za-z0-9_-]{1,64}$", "title": "Name", "type": "string" }, "namespace": { "anyOf": [ { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "type": "string" }, { "type": "null" } ], "description": "the `namespace` tools[] entry the called tool belongs to, as Core answered it: the call is replayed to the model under the one flattened name it was offered, `ns___`", "title": "Namespace" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the item's status; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Status" }, "type": { "const": "custom_tool_call", "default": "custom_tool_call", "description": "input item kind", "title": "Type", "type": "string" } }, "required": [ "call_id", "name", "input" ], "title": "CustomToolCallInput", "type": "object" }, "CustomToolCallOutput": { "additionalProperties": false, "description": "A call on a custom (freeform) tool the *caller* executes: its one free-text input, which\nCore forwards and waits for the result of, as it does a `function_call`\n(`openai.types.responses.ResponseCustomToolCall`).", "properties": { "call_id": { "description": "id correlating this call with its result", "title": "Call Id", "type": "string" }, "id": { "description": "the item's id", "title": "Id", "type": "string" }, "input": { "description": "the call's free-text input, as the model wrote it", "title": "Input", "type": "string" }, "name": { "description": "the custom tool's name; inside its namespace, when it has one", "title": "Name", "type": "string" }, "namespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the `namespace` tools[] entry the called tool belongs to, so the caller routes the call to the tool it declared; null for a tool offered on its own", "title": "Namespace" }, "type": { "const": "custom_tool_call", "default": "custom_tool_call", "description": "output item kind", "title": "Type", "type": "string" } }, "required": [ "id", "call_id", "name", "input" ], "title": "CustomToolCallOutput", "type": "object" }, "CustomToolCallOutputInput": { "additionalProperties": false, "description": "A `custom_tool_call_output` submitted on the request: a custom tool's result, which Core\nreads exactly as a function tool's -- the caller's untrusted data, matched to its call by\n`call_id`.", "properties": { "call_id": { "description": "id correlating this output with its custom_tool_call", "title": "Call Id", "type": "string" }, "caller": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the context that produced the output; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Caller" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the item's id; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Id" }, "output": { "anyOf": [ { "maxLength": 1048576, "type": "string" }, { "items": { "discriminator": { "mapping": { "input_image": "#/components/schemas/InputImagePart", "input_text": "#/components/schemas/InputTextPart" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/InputTextPart" }, { "$ref": "#/components/schemas/InputImagePart" } ] }, "type": "array" } ], "description": "the tool's output: its text, at most 1 MiB, or a list of `input_text` and `input_image` parts whose text, joined, is at most 1 MiB. An image is read by the model as the tool's data, never as the user's", "title": "Output" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the item's status; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Status" }, "type": { "const": "custom_tool_call_output", "default": "custom_tool_call_output", "description": "input item kind", "title": "Type", "type": "string" } }, "required": [ "call_id", "output" ], "title": "CustomToolCallOutputInput", "type": "object" }, "CustomToolEcho": { "additionalProperties": false, "description": "A `custom` (freeform) tool the request offered, as it was accepted.", "properties": { "description": { "description": "the tool's description", "title": "Description", "type": "string" }, "format": { "anyOf": [ { "discriminator": { "mapping": { "grammar": "#/components/schemas/CustomToolFormatGrammar", "text": "#/components/schemas/CustomToolFormatText" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CustomToolFormatText" }, { "$ref": "#/components/schemas/CustomToolFormatGrammar" } ] }, { "type": "null" } ], "description": "what the tool's input must look like; null for free text", "title": "Format" }, "name": { "description": "the tool's name", "title": "Name", "type": "string" }, "type": { "const": "custom", "default": "custom", "description": "tool kind", "title": "Type", "type": "string" } }, "required": [ "name", "description" ], "title": "CustomToolEcho", "type": "object" }, "CustomToolFormatGrammar": { "additionalProperties": false, "description": "A custom tool's input must match a grammar the caller wrote.", "properties": { "definition": { "description": "the grammar itself, at most 1 MiB", "maxLength": 1048576, "title": "Definition", "type": "string" }, "syntax": { "description": "the grammar's syntax", "enum": [ "lark", "regex" ], "title": "Syntax", "type": "string" }, "type": { "const": "grammar", "default": "grammar", "description": "input format kind", "title": "Type", "type": "string" } }, "required": [ "syntax", "definition" ], "title": "CustomToolFormatGrammar", "type": "object" }, "CustomToolFormatText": { "additionalProperties": false, "description": "A custom tool's input is unconstrained text: the default.", "properties": { "type": { "const": "text", "default": "text", "description": "input format kind", "title": "Type", "type": "string" } }, "title": "CustomToolFormatText", "type": "object" }, "CustomToolIn": { "additionalProperties": false, "description": "A tool the caller executes itself: Anthropic's own tool definition.", "properties": { "cache_control": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the vendor's prompt-cache hint; accepted and ignored: a hint that does not change what the answer means, so it is neither refused nor forwarded, stored or echoed", "title": "Cache Control" }, "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "the vendor's tool-search hint: `true` on any entry puts the whole call behind the tool router, as `tool_search` `router` would, never this tool alone; Core's own `tool_search` wins over it", "title": "Defer Loading" }, "description": { "default": "", "description": "what the tool does", "maxLength": 16384, "title": "Description", "type": "string" }, "eager_input_streaming": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "the vendor's hint to stream tool input before it is complete; accepted and ignored: a hint that does not change what the answer means, so it is neither refused nor forwarded, stored or echoed", "title": "Eager Input Streaming" }, "input_schema": { "additionalProperties": true, "default": { "properties": {}, "type": "object" }, "description": "JSON Schema for the tool's input", "title": "Input Schema", "type": "object" }, "name": { "description": "the tool's name", "title": "Name", "type": "string" }, "strict": { "default": false, "description": "require the model to follow the schema", "title": "Strict", "type": "boolean" }, "type": { "const": "custom", "default": "custom", "description": "tool kind", "title": "Type", "type": "string" } }, "required": [ "name" ], "title": "CustomToolIn", "type": "object" }, "CustomToolParam": { "additionalProperties": false, "description": "A client-supplied custom (freeform) tool: executed by the caller like a `function` tool,\nbut called with one free text rather than a JSON object (`docs/architecture/tooling.md`,\n\"Client tools vs server tools\").\n\nA model that takes custom tools natively -- OpenAI's Responses API -- is handed it as it is,\ngrammar included. Every other is handed a function tool with one string argument, `input`,\nwhich cannot hold the model to a grammar, so a `grammar` format on such a model is refused\nat admission naming `tools.N.format`; a `text` format is what the emulation does\n(`app.providers.custom_tools`).", "properties": { "allowed_callers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "the contexts that may call the tool; accepted and ignored: a hint that does not change what the answer means, so Core never forwards it, stores it or answers it back", "title": "Allowed Callers" }, "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "the vendor's tool-search hint: `true` on any entry of a request puts the whole call behind the tool router, as `tool_search` `router` would, never this tool alone; Core's own `tool_search` wins over it", "title": "Defer Loading" }, "description": { "default": "", "description": "the tool's description, at most 16384 characters", "maxLength": 16384, "title": "Description", "type": "string" }, "format": { "anyOf": [ { "discriminator": { "mapping": { "grammar": "#/components/schemas/CustomToolFormatGrammar", "text": "#/components/schemas/CustomToolFormatText" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CustomToolFormatText" }, { "$ref": "#/components/schemas/CustomToolFormatGrammar" } ] }, { "type": "null" } ], "description": "what the input must look like: unconstrained `text` (the default), or a `grammar`, which only a model that takes custom tools natively can be held to", "title": "Format" }, "name": { "description": "the tool's name", "title": "Name", "type": "string" }, "type": { "const": "custom", "default": "custom", "description": "tool param kind", "title": "Type", "type": "string" } }, "required": [ "name" ], "title": "CustomToolParam", "type": "object" }, "DatastoreBatch": { "additionalProperties": false, "description": "Body of `POST /datastores/batch`: operations applied all together or not at all. Named\nfor what it is rather than `Create`: it is applied, and stored as nothing of its own.", "properties": { "operations": { "description": "the operations, in the order they are applied, across any of the organisation's datastores this key reaches; a later one sees what earlier ones wrote", "items": { "discriminator": { "mapping": { "counter": "#/components/schemas/DatastoreBatchCounter", "delete": "#/components/schemas/DatastoreBatchDelete", "put": "#/components/schemas/DatastoreBatchPut" }, "propertyName": "op" }, "oneOf": [ { "$ref": "#/components/schemas/DatastoreBatchPut" }, { "$ref": "#/components/schemas/DatastoreBatchDelete" }, { "$ref": "#/components/schemas/DatastoreBatchCounter" } ] }, "maxItems": 100, "minItems": 1, "title": "Operations", "type": "array" } }, "required": [ "operations" ], "title": "DatastoreBatch", "type": "object" }, "DatastoreBatchCounter": { "additionalProperties": false, "description": "One batch operation taking the next number of a datastore's counter.", "properties": { "counter": { "description": "the counter's name", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "title": "Counter", "type": "string" }, "datastore_id": { "description": "The datastore the counter belongs to", "title": "Datastore Id", "type": "string" }, "op": { "const": "counter", "description": "Take a counter's next number", "title": "Op", "type": "string" } }, "required": [ "op", "datastore_id", "counter" ], "title": "DatastoreBatchCounter", "type": "object" }, "DatastoreBatchDelete": { "additionalProperties": false, "description": "One batch operation deleting a record, as `DELETE .../records/{key}` deletes it.", "properties": { "datastore_id": { "description": "The datastore the record is in", "title": "Datastore Id", "type": "string" }, "if_match": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "the `etag` the record must still carry, as `If-Match` takes it", "title": "If Match" }, "key": { "description": "the record's key", "pattern": "^[A-Za-z0-9_.:-]{1,128}$", "title": "Key", "type": "string" }, "op": { "const": "delete", "description": "Delete a record", "title": "Op", "type": "string" } }, "required": [ "op", "datastore_id", "key" ], "title": "DatastoreBatchDelete", "type": "object" }, "DatastoreBatchPut": { "additionalProperties": false, "description": "One batch operation writing a record, as `PUT .../records/{key}` writes it.", "properties": { "data": { "additionalProperties": true, "description": "the record, as the single write takes it", "title": "Data", "type": "object" }, "datastore_id": { "description": "The datastore the record is in", "title": "Datastore Id", "type": "string" }, "if_absent": { "default": false, "description": "true to create the record only, as `If-None-Match: *` asks", "title": "If Absent", "type": "boolean" }, "if_match": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "the `etag` the record must still carry, as `If-Match` takes it", "title": "If Match" }, "key": { "anyOf": [ { "pattern": "^[A-Za-z0-9_.:-]{1,128}$", "type": "string" }, { "type": "null" } ], "description": "the record's key; or give `key_from`", "title": "Key" }, "key_from": { "anyOf": [ { "$ref": "#/components/schemas/DatastoreKeyFrom" }, { "type": "null" } ], "description": "a key made from an earlier counter's number; or give `key`" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "labels the rules over this row's kind read, as label -> a value or a list of 1 to 32 distinct values, each of 1 to 256 characters; at most 32 names. Held to the organisation's vocabulary and, for a request naming a person, to `writable_labels`; omitted or null keeps the record's labels", "title": "Labels" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "as the single write takes it; omitted or null stores {}", "title": "Metadata" }, "op": { "const": "put", "description": "Write a record", "title": "Op", "type": "string" } }, "required": [ "op", "datastore_id", "data" ], "title": "DatastoreBatchPut", "type": "object" }, "DatastoreBatchRead": { "description": "`POST /datastores/batch`'s answer once every operation is written.", "properties": { "object": { "const": "datastore.batch", "default": "datastore.batch", "description": "The object's type", "title": "Object", "type": "string" }, "results": { "description": "One per operation, in its order", "items": { "$ref": "#/components/schemas/DatastoreBatchResult" }, "title": "Results", "type": "array" } }, "required": [ "results" ], "title": "DatastoreBatchRead", "type": "object" }, "DatastoreBatchResult": { "description": "What one operation of a batch did.", "properties": { "created": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether a put created the record; null for a delete or counter", "title": "Created" }, "datastore_id": { "description": "The datastore it acted on", "title": "Datastore Id", "type": "string" }, "etag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The written record's `etag`; null for a delete or counter", "title": "Etag" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The record's key; null for a counter", "title": "Key" }, "op": { "description": "The operation's kind", "enum": [ "put", "delete", "counter" ], "title": "Op", "type": "string" }, "value": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The number a counter handed out; null otherwise", "title": "Value" } }, "required": [ "op", "datastore_id", "key", "etag", "created", "value" ], "title": "DatastoreBatchResult", "type": "object" }, "DatastoreCounterRead": { "description": "The number a datastore's counter handed out, from `POST .../counters/{name}/next`.", "properties": { "datastore_id": { "description": "Owning datastore id", "title": "Datastore Id", "type": "string" }, "name": { "description": "The counter's name, unique within its datastore", "title": "Name", "type": "string" }, "object": { "const": "datastore.counter", "default": "datastore.counter", "description": "The object's type", "title": "Object", "type": "string" }, "value": { "description": "The number handed out: 1 on first use, one more each time after. Held by the request's own transaction, so a request that fails gives it back", "title": "Value", "type": "integer" } }, "required": [ "datastore_id", "name", "value" ], "title": "DatastoreCounterRead", "type": "object" }, "DatastoreCreate": { "additionalProperties": false, "description": "Body of `POST /datastores`.", "properties": { "description": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "what the datastore holds, for a person and for the model its tools are offered to", "title": "Description" }, "emit_events": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "whether each write and delete of a record raises a feed event (`datastore.record.written`, `.deleted`) an event trigger or a webhook can act on; omitted or null for none", "title": "Emit Events" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "an opaque document a caller attaches to the datastore, at most 16 KiB serialised: stored, returned and never read by Core; omitted or null stores {}", "title": "Metadata" }, "name": { "description": "unique name within the organisation; what a policy glob and a reference name it by, and never changed afterwards", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "title": "Name", "type": "string" }, "record_ttl_days": { "anyOf": [ { "maximum": 3650.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "days after its last write a record is deleted, whatever the organisation's own retention window says; null for no expiry of its own", "title": "Record Ttl Days" }, "retained_for": { "anyOf": [ { "$ref": "#/components/schemas/RetainedFor" }, { "type": "null" } ], "description": "`bookkeeping` keeps the records past a person's erasure, still naming her, and past the organisation's own window, until `record_ttl_days`, which it then requires; null for none" }, "retention": { "default": "window", "description": "whether the organisation's retention window covers this datastore's records: 'window' lets the pass take them once older than the window, 'keep' keeps them; a person's erasure takes her records either way, and `record_ttl_days` still applies; 'window' when absent", "enum": [ "window", "keep" ], "title": "Retention", "type": "string" }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/DatastoreSchemaWrite" }, { "type": "null" } ], "description": "the first schema version, written with the datastore; absent or null leaves the datastore without one until `PUT .../schema`" }, "write_function": { "anyOf": [ { "$ref": "#/components/schemas/DatastoreWriteFunction" }, { "type": "null" } ], "description": "the function every put and delete of a record runs first, which may complete the record or refuse the write; null for none" } }, "required": [ "name" ], "title": "DatastoreCreate", "type": "object" }, "DatastoreKeyFrom": { "additionalProperties": false, "description": "A key made from the number an earlier counter operation of the same batch took:\n`prefix` and the number's digits, `O-` and 7 making `O-7`.", "properties": { "operation": { "description": "the index of an earlier `counter` operation in this batch", "minimum": 0.0, "title": "Operation", "type": "integer" }, "prefix": { "default": "", "description": "what the key starts with", "pattern": "^[A-Za-z0-9_.:-]{0,64}$", "title": "Prefix", "type": "string" } }, "required": [ "operation" ], "title": "DatastoreKeyFrom", "type": "object" }, "DatastoreRead": { "description": "A datastore, as the API returns it.", "properties": { "created_at": { "description": "When it was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created it: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "What the datastore holds", "title": "Description" }, "emit_events": { "description": "Whether each write and delete of a record raises a feed event", "title": "Emit Events", "type": "boolean" }, "id": { "description": "Datastore id", "title": "Id", "type": "string" }, "latest_schema_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The version records are validated against now; null when it has none", "title": "Latest Schema Version" }, "metadata": { "additionalProperties": true, "description": "The opaque document attached to it", "title": "Metadata", "type": "object" }, "name": { "description": "Unique name within the organisation", "title": "Name", "type": "string" }, "object": { "const": "datastore", "default": "datastore", "description": "The object's type", "title": "Object", "type": "string" }, "record_ttl_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Days after its last write a record is deleted; null for no expiry of its own", "title": "Record Ttl Days" }, "retained_for": { "anyOf": [ { "$ref": "#/components/schemas/RetainedFor" }, { "type": "null" } ], "description": "`bookkeeping` when its records outlive a person's erasure and the organisation's window until `record_ttl_days`; null otherwise" }, "retention": { "description": "Whether the organisation's retention window covers this datastore's records: 'window' lets the pass take them once older than the window, 'keep' keeps them; a person's erasure takes her records either way, and `record_ttl_days` still applies", "enum": [ "window", "keep" ], "title": "Retention", "type": "string" }, "updated_at": { "description": "When its description, metadata or schema changed", "format": "date-time", "title": "Updated At", "type": "string" }, "write_function": { "anyOf": [ { "$ref": "#/components/schemas/DatastoreWriteFunction" }, { "type": "null" } ], "description": "The function every put and delete of a record runs first; null for none" } }, "required": [ "id", "name", "description", "metadata", "latest_schema_version", "record_ttl_days", "retained_for", "retention", "emit_events", "write_function", "created_by", "created_at", "updated_at" ], "title": "DatastoreRead", "type": "object" }, "DatastoreRecordQuery": { "additionalProperties": false, "description": "Body of `POST /datastores/{datastore_id}/records/query`: which records, in what order.\nNamed for what it is rather than `Create`: it reads, and stores nothing.", "properties": { "filters": { "description": "conditions a record must all meet. A field is a top-level field of `data`, compared as the type the datastore's latest schema declares for it and as text when it declares none; `$key`, `$created_at` and `$updated_at` address the record's key and the two timestamps Core sets", "items": { "$ref": "#/components/schemas/FieldFilter" }, "maxItems": 20, "title": "Filters", "type": "array" }, "sort": { "anyOf": [ { "$ref": "#/components/schemas/RecordSort" }, { "type": "null" } ], "description": "the field to order by, records that hold no value for it last and ties in key order; a string field is ordered by its first 256 characters. Omitted or null orders by `$key`" } }, "title": "DatastoreRecordQuery", "type": "object" }, "DatastoreRecordRead": { "description": "One record, as the API returns it.", "properties": { "created_at": { "description": "When it was first written", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who first wrote it: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "data": { "additionalProperties": true, "description": "The record", "title": "Data", "type": "object" }, "datastore_id": { "description": "Owning datastore id", "title": "Datastore Id", "type": "string" }, "etag": { "description": "The record at this revision, as the `ETag` header carries it: send it back in `If-Match` to have a write refused `412` when the record has moved since. Opaque; a key deleted and written again never matches an old one", "title": "Etag", "type": "string" }, "key": { "description": "The record's key, unique within its datastore", "title": "Key", "type": "string" }, "labels": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "the labels the rules over this row's kind read, as label -> a value or a list of values, read back exactly as written", "title": "Labels", "type": "object" }, "metadata": { "additionalProperties": true, "description": "The opaque document attached to the record", "title": "Metadata", "type": "object" }, "object": { "const": "datastore.record", "default": "datastore.record", "description": "The object's type", "title": "Object", "type": "string" }, "references": { "description": "The references its schema version declared and its data carries", "items": { "$ref": "#/components/schemas/DatastoreRecordReferenceRead" }, "title": "References", "type": "array" }, "revision": { "description": "1 when the record was first written, raised by one on every write", "title": "Revision", "type": "integer" }, "schema_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The schema version it was validated against when written; null when its datastore had none. A later schema does not revalidate it", "title": "Schema Version" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person it was written for; null when shared, or when a credential bound to one person reads another person's record", "title": "Subject" }, "updated_at": { "description": "When it was last written", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "datastore_id", "key", "data", "metadata", "labels", "schema_version", "references", "revision", "etag", "subject", "created_by", "created_at", "updated_at" ], "title": "DatastoreRecordRead", "type": "object" }, "DatastoreRecordReferenceRead": { "description": "One reference a record carries, as it stands now.", "properties": { "dangling": { "description": "true when no record of that key is there for this caller now -- deleted since the write, or its datastore gone; the pointer stays as it was written", "title": "Dangling", "type": "boolean" }, "datastore": { "description": "The datastore it points into", "title": "Datastore", "type": "string" }, "key": { "description": "The key it names", "title": "Key", "type": "string" }, "pointer": { "description": "Where in `data` the key was found", "title": "Pointer", "type": "string" } }, "required": [ "pointer", "datastore", "key", "dangling" ], "title": "DatastoreRecordReferenceRead", "type": "object" }, "DatastoreRecordWrite": { "additionalProperties": false, "description": "Body of `PUT /datastores/{datastore_id}/records/{key}`: the whole record, replaced.", "properties": { "data": { "additionalProperties": true, "description": "the record: a JSON object, validated against the latest schema version and its references", "title": "Data", "type": "object" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "labels the rules over this row's kind read, as label -> a value or a list of 1 to 32 distinct values, each of 1 to 256 characters; at most 32 names. Held to the organisation's vocabulary and, for a request naming a person, to `writable_labels`; omitted or null keeps the record's labels, {} clears them", "title": "Labels" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "a document attached to the record, at most 16 KiB serialised: the application's own, read by no rule except, for one release, a string under a name `labels` lack; omitted or null stores {}", "title": "Metadata" } }, "required": [ "data" ], "title": "DatastoreRecordWrite", "type": "object" }, "DatastoreReference": { "additionalProperties": false, "description": "One declared reference: the value at `pointer` inside a record's `data` is the key of a\nrecord in the datastore called `datastore`.", "properties": { "datastore": { "description": "the name of the datastore the key points into; it must exist when the schema version is written", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "title": "Datastore", "type": "string" }, "pointer": { "description": "a JSON Pointer (RFC 6901) into a record's `data`, such as `/customer_id`; the value found there is a record key, or absent or null for no reference", "maxLength": 512, "pattern": "^(/([^~/]|~[01])*)+$", "title": "Pointer", "type": "string" } }, "required": [ "pointer", "datastore" ], "title": "DatastoreReference", "type": "object" }, "DatastoreSchemaVersionRead": { "description": "One immutable schema version.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "created_at": { "description": "When it was written", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who wrote it: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "datastore_id": { "description": "Owning datastore id", "title": "Datastore Id", "type": "string" }, "id": { "description": "Schema version id", "title": "Id", "type": "string" }, "json_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The JSON Schema records were validated against; null for none", "title": "Json Schema" }, "object": { "const": "datastore.schema_version", "default": "datastore.schema_version", "description": "The object's type", "title": "Object", "type": "string" }, "references": { "description": "The declared references", "items": { "$ref": "#/components/schemas/DatastoreReference" }, "title": "References", "type": "array" }, "unique": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The field no two records of one namespace share a value of while this is the latest version; null for none", "title": "Unique" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" } }, "required": [ "id", "datastore_id", "version", "json_schema", "references", "unique", "created_by", "acted_for", "created_at" ], "title": "DatastoreSchemaVersionRead", "type": "object" }, "DatastoreSchemaWrite": { "additionalProperties": false, "description": "Body of `PUT /datastores/{datastore_id}/schema`: the schema and references every record\nwritten from now on is checked against. A body equal to the latest version writes nothing.", "properties": { "json_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "a JSON Schema (Draft 2020-12) a record's `data` must satisfy, or null for no validation. Only same-document `$ref`s (`#/...`) resolve: Core never fetches a schema from anywhere, and a remote `$ref` is refused", "title": "Json Schema" }, "references": { "description": "the pointers in a record's `data` that name a record of another datastore; a write whose pointer names a record that does not exist is refused", "items": { "$ref": "#/components/schemas/DatastoreReference" }, "maxItems": 32, "title": "References", "type": "array" }, "unique": { "anyOf": [ { "pattern": "^[A-Za-z_][A-Za-z0-9_.-]{0,63}$", "type": "string" }, { "type": "null" } ], "description": "a top-level field of `data` no two records of one namespace may share a value of -- a string or an integer; a record without it is unconstrained. Declaring it over records that already share a value is refused with 409", "title": "Unique" } }, "title": "DatastoreSchemaWrite", "type": "object" }, "DatastoreUpdate": { "additionalProperties": false, "description": "Body of `PATCH /datastores/{datastore_id}`: an absent field is left as it is. The name is\nnot here -- references and policy globs name a datastore by it, so it never changes.", "properties": { "description": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "the new description", "title": "Description" }, "emit_events": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "switch the record events on or off; absent leaves it as it is", "title": "Emit Events" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the new opaque document; {} clears it", "title": "Metadata" }, "record_ttl_days": { "anyOf": [ { "maximum": 3650.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "the new expiry in days after a record's last write; null clears it", "title": "Record Ttl Days" }, "retained_for": { "anyOf": [ { "$ref": "#/components/schemas/RetainedFor" }, { "type": "null" } ], "description": "`bookkeeping` keeps the records past a person's erasure, still naming her, and past the organisation's own window, until `record_ttl_days`, which it then requires; null clears it, which a delete needs first" }, "retention": { "anyOf": [ { "enum": [ "window", "keep" ], "type": "string" }, { "type": "null" } ], "description": "whether the organisation's retention window covers this datastore's records: 'window' lets the pass take them once older than the window, 'keep' keeps them; a person's erasure takes her records either way, and `record_ttl_days` still applies; absent or null leaves it as it is", "title": "Retention" }, "write_function": { "anyOf": [ { "$ref": "#/components/schemas/DatastoreWriteFunction" }, { "type": "null" } ], "description": "the new function every put and delete of a record runs first; null clears it" } }, "title": "DatastoreUpdate", "type": "object" }, "DatastoreWriteFunction": { "additionalProperties": false, "description": "The function every put and delete of a datastore's records runs before it is stored.", "properties": { "name": { "description": "the function's name; it must have a published version that declares no reads and no writes", "pattern": "^[a-z0-9_-]{1,48}$", "title": "Name", "type": "string" }, "version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "the published version every write runs; null runs the latest published version at each write", "title": "Version" } }, "required": [ "name" ], "title": "DatastoreWriteFunction", "type": "object" }, "DatastoresConfig": { "additionalProperties": false, "description": "The `datastores` capability: named collections of JSON records a key reads and writes over\nits own routes, and a turn reads and writes as tools (`docs/architecture/datastores.md`).\n\nNo dependency: a datastore stands on nothing else. The two switches say which of a\ndatastore's five tools a turn may be offered, the way `MemoryConfig.retrieval_tool` and\n`write_tool` do for memory; the routes are the capability itself and have no switch.", "properties": { "read_tools": { "default": true, "description": "whether a run may be offered a datastore's `get`, `list` and `query` tools", "title": "Read Tools", "type": "boolean" }, "write_tools": { "default": true, "description": "whether a run may be offered a datastore's `put` and `delete` tools", "title": "Write Tools", "type": "boolean" } }, "title": "DatastoresConfig", "type": "object" }, "DecayRule": { "additionalProperties": false, "description": "How fast one memory type's confidence decays.", "properties": { "half_life_days": { "description": "days for a memory's confidence to halve", "exclusiveMinimum": 0.0, "title": "Half Life Days", "type": "number" } }, "required": [ "half_life_days" ], "title": "DecayRule", "type": "object" }, "DecisionCreate": { "additionalProperties": false, "description": "A text and either labels or one yes-or-no question.", "properties": { "input": { "anyOf": [ { "type": "string" }, { "items": { "$ref": "#/components/schemas/DecisionMessage" }, "type": "array" } ], "description": "the text, or a short list of messages Core flattens as `: ` one empty line apart; at most decisions_input_max_chars characters after flattening (8,000 by default)", "title": "Input" }, "labels": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DecisionLabelCreate" }, "type": "array" }, { "type": "null" } ], "description": "2 to decisions_labels_max labels (50 by default), one of which is chosen; send labels or question, exactly one", "title": "Labels" }, "model": { "description": "catalogue id of a decision model", "maxLength": 200, "minLength": 1, "title": "Model", "type": "string" }, "question": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "one yes-or-no question, 1 to 500 characters, in place of labels", "title": "Question" } }, "required": [ "model", "input" ], "title": "DecisionCreate", "type": "object" }, "DecisionLabelCreate": { "additionalProperties": false, "description": "One label the model may choose.", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "what the label means, at most 500 characters", "title": "Description" }, "name": { "description": "1 to 100 characters, unique within the list", "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "DecisionLabelCreate", "type": "object" }, "DecisionMessage": { "additionalProperties": false, "description": "One message of an input given as a list.", "properties": { "role": { "description": "who wrote the message", "enum": [ "user", "assistant", "system" ], "title": "Role", "type": "string" }, "text": { "description": "what the message says", "title": "Text", "type": "string" } }, "required": [ "role", "text" ], "title": "DecisionMessage", "type": "object" }, "DecisionRead": { "description": "The model's choice, never free text.", "properties": { "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the chosen label's name; null for a question", "title": "Label" }, "model": { "description": "the decision model that decided", "title": "Model", "type": "string" }, "object": { "const": "decision", "default": "decision", "description": "always `decision`", "title": "Object", "type": "string" }, "p_true": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "the probability of yes; null for labels", "title": "P True" }, "probabilities": { "anyOf": [ { "additionalProperties": { "type": "number" }, "type": "object" }, { "type": "null" } ], "description": "each label's probability by name, in the order sent, summing to 1; null for a question", "title": "Probabilities" }, "usage": { "$ref": "#/components/schemas/DecisionUsage", "description": "what the call is billed for" } }, "required": [ "model", "label", "probabilities", "p_true", "usage" ], "title": "DecisionRead", "type": "object" }, "DecisionUsage": { "description": "What the call is billed for.", "properties": { "input_tokens": { "description": "the input tokens the model reported reading", "title": "Input Tokens", "type": "integer" } }, "required": [ "input_tokens" ], "title": "DecisionUsage", "type": "object" }, "DeclaredRecord": { "additionalProperties": false, "description": "One record read by key before the call runs; an absent record reads as null.", "properties": { "as": { "description": "the name the module finds the record under in the input's `reads`", "pattern": "^[a-z_][a-z0-9_]{0,31}$", "title": "As", "type": "string" }, "datastore": { "description": "A datastore's name", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "title": "Datastore", "type": "string" }, "key": { "description": "a JMESPath expression over `{arguments, reads}` -- the call's arguments and the reads declared before this one -- giving the record's key", "maxLength": 1024, "minLength": 1, "title": "Key", "type": "string" }, "kind": { "const": "record", "description": "Read one record by key", "title": "Kind", "type": "string" } }, "required": [ "kind", "as", "datastore", "key" ], "title": "DeclaredRecord", "type": "object" }, "DeclaredRecords": { "additionalProperties": false, "description": "Records read by a list of keys before the call runs, one entry per key, null for a key\nthat names no record.", "properties": { "as": { "description": "the name the module finds the list under in the input's `reads`", "pattern": "^[a-z_][a-z0-9_]{0,31}$", "title": "As", "type": "string" }, "datastore": { "description": "A datastore's name", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "title": "Datastore", "type": "string" }, "keys": { "description": "a JMESPath expression over `{arguments, reads}` giving a list of keys, at most the deployment's `functions_read_keys_max`; null reads none", "maxLength": 1024, "minLength": 1, "title": "Keys", "type": "string" }, "kind": { "const": "records", "description": "Read records by a list of keys", "title": "Kind", "type": "string" } }, "required": [ "kind", "as", "datastore", "keys" ], "title": "DeclaredRecords", "type": "object" }, "DetectionSettings": { "additionalProperties": false, "description": "What counts as personal data, and how sure the detector has to be before it is hidden:\nwhat a thread records of the key that hid it, and what an improvement analysis hides by\n(`docs/architecture/responses.md`).\n\n`LOCATION` is deliberately not among the defaults: replacing place names costs a model most\nof its usefulness for the least gain, so a key that wants it asks for it.", "properties": { "entities": { "default": [ "PERSON", "EMAIL_ADDRESS", "PHONE_NUMBER", "IBAN_CODE", "CREDIT_CARD", "NL_BSN" ], "description": "entity types hidden from the model, at least one; LOCATION is opt-in", "items": { "enum": [ "PERSON", "LOCATION", "EMAIL_ADDRESS", "PHONE_NUMBER", "IBAN_CODE", "CREDIT_CARD", "IP_ADDRESS", "NL_BSN", "DE_TAX_ID", "ES_NIF", "ES_NIE" ], "type": "string" }, "title": "Entities", "type": "array" }, "language": { "default": "nl", "description": "language every text on this key's turns is analysed as", "enum": [ "nl", "en", "de", "fr", "es" ], "title": "Language", "type": "string" }, "score_threshold": { "default": 0.5, "description": "minimum detector confidence for a span to be hidden", "maximum": 1.0, "minimum": 0.0, "title": "Score Threshold", "type": "number" } }, "title": "DetectionSettings", "type": "object" }, "DirectToolCallRead": { "description": "One tool call and its result: the call as a turn would write it, and the result as a\nmodel would read it.", "properties": { "arguments": { "additionalProperties": true, "description": "The arguments the tool was run with", "title": "Arguments", "type": "object" }, "call_id": { "description": "The call's own id, which the `policy.decision` audit rows carry in their refs", "title": "Call Id", "type": "string" }, "decision": { "$ref": "#/components/schemas/ToolCallDecision", "description": "The decision that decided the call: the first one in `decisions` that refused it when `status` is `denied`, the rules over the tool otherwise -- also for a denial the tool made without a decision of its own to list" }, "decisions": { "description": "Every policy decision the call took, in the order taken: the rules over the tool first, then each check the tool itself made, an egress check among them. One `policy.decision` audit row each", "items": { "$ref": "#/components/schemas/ToolCallDecision" }, "title": "Decisions", "type": "array" }, "duration_ms": { "description": "How long the call took, from the decision to the recorded result, in milliseconds", "title": "Duration Ms", "type": "number" }, "error_code": { "anyOf": [ { "enum": [ "vendor_error", "transport_error", "invalid_response", "invalid_arguments", "egress_refused", "denied_by_policy", "timeout", "executor_failed", "auth_failed", "unknown_tool", "max_uses_exceeded", "usage_cap_exceeded", "cost_limit", "call_depth_exceeded", "computer_busy", "trapped", "fuel_exhausted", "memory_exceeded", "conflict", "pseudonymisation_failed" ], "type": "string" }, { "type": "null" } ], "description": "Why the call did not end `ok`, as a fixed code; null when it did", "title": "Error Code" }, "name": { "description": "The tool's qualified name, as the path gave it", "title": "Name", "type": "string" }, "object": { "const": "tool_call", "default": "tool_call", "description": "The object's type", "title": "Object", "type": "string" }, "outputs": { "description": "Every binary output the tool produced, carried or only noted", "items": { "$ref": "#/components/schemas/ToolCallOutput" }, "title": "Outputs", "type": "array" }, "status": { "description": "How the call ended: `ok`, `denied` when Core refused it (policy, or the egress rule an executor applies), `error` when the tool failed or ran out of time", "enum": [ "ok", "error", "denied", "cancelled" ], "title": "Status", "type": "string" }, "structured": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "items": {}, "type": "array" }, { "type": "null" } ], "description": "The tool's structured content, when it answered any", "title": "Structured" }, "text": { "description": "What a model would read: the tool's text, its structured content rendered as compact JSON, or Core's own sentence when it did not run -- with a note appended for binary outputs that are not carried", "title": "Text", "type": "string" }, "vendor_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The HTTP status the tool's own destination answered, a success's too; null when there was no destination or it never answered", "title": "Vendor Status" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The version of the tool that ran: the pinned `version`, or the one a call without a pin resolved to at this call. Null for a tool that has no versions", "title": "Version" } }, "required": [ "call_id", "name", "arguments", "status", "error_code", "vendor_status", "text", "structured", "outputs", "decision", "decisions", "duration_ms", "version" ], "title": "DirectToolCallRead", "type": "object" }, "DocumentBlockIn": { "additionalProperties": false, "description": "A `document` block. Core takes one by `file_id` only: a document's bytes are uploaded\nonce and referenced, never carried on a turn.", "properties": { "cache_control": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the vendor's prompt-cache hint; accepted and ignored: a hint that does not change what the answer means, so it is neither refused nor forwarded, stored or echoed", "title": "Cache Control" }, "source": { "$ref": "#/components/schemas/FileSource", "description": "the Core file this document is" }, "type": { "const": "document", "default": "document", "description": "content block kind", "title": "Type", "type": "string" } }, "required": [ "source" ], "title": "DocumentBlockIn", "type": "object" }, "EdgeConfig": { "additionalProperties": false, "properties": { "source": { "description": "upstream node id", "pattern": "^[A-Za-z0-9_-]{1,64}$", "title": "Source", "type": "string" }, "source_port": { "anyOf": [ { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, { "type": "null" } ], "description": "the upstream node's output port this edge leaves; null is its main output", "title": "Source Port" }, "target": { "description": "downstream node id", "pattern": "^[A-Za-z0-9_-]{1,64}$", "title": "Target", "type": "string" }, "target_port": { "anyOf": [ { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, { "type": "null" } ], "description": "the downstream node's input port this edge reaches; null is its main input", "title": "Target Port" } }, "required": [ "source", "target" ], "title": "EdgeConfig", "type": "object" }, "EdgeRule": { "additionalProperties": false, "description": "One edge's rule: which tools, what they are sent, and optionally which arguments.", "properties": { "arguments": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 50, "minItems": 1, "type": "array" }, { "type": "null" } ], "description": "the top-level arguments the mode covers; left out, every argument", "title": "Arguments" }, "mode": { "description": "'clear' sends the values as written; 'hide' puts every value the turn's mapping holds back behind its placeholder; 'detect' also has the detector read the arguments, so a name the model wrote itself is hidden too", "enum": [ "clear", "hide", "detect" ], "title": "Mode", "type": "string" }, "tools": { "description": "the edge, in a closed grammar: 'builtin:web_search', 'builtin:web_fetch', 'builtin:generate_image' (every image tool), 'builtin:transcribe_audio' (every transcription tool's prompt), 'builtin:computer'; 'api:', 'sql:', 'mail:', 'mcp:', 'script:' for every tool that registration offers; 'tool:' for one tool as the model is offered it, an alias included; or '*' for every edge no other entry names. Core's own tools are no edge", "maxLength": 80, "title": "Tools", "type": "string" } }, "required": [ "tools", "mode" ], "title": "EdgeRule", "type": "object" }, "EffectiveMetadataRead": { "description": "`GET .../metadata/effective`: an organisation's own document with the keys its ancestors\nlend it, merged by top-level key (`app.tenants.own_document`).", "properties": { "inherited_from": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Each key of metadata that came from above, mapped to the id of the organisation it came from; null when the caller does not reach that organisation. A key of this organisation's own is not listed", "title": "Inherited From", "type": "object" }, "metadata": { "additionalProperties": true, "description": "This organisation's own metadata, plus each key it lacks from the nearest organisation above it that lists the key in inheritable_keys and holds it", "title": "Metadata", "type": "object" } }, "required": [ "metadata", "inherited_from" ], "title": "EffectiveMetadataRead", "type": "object" }, "ElementToolCall": { "description": "One tool call an element asked for, as the reading points at it.\n\n`app.turns.items.ToolCallRef` is the other half of the same fact and is deliberately not\nthis: that one is the stored item, carrying the arguments as text Core keeps. This one carries\nno arguments at all, only a pointer at the arguments **as the vendor received them**, for the\nsame reason an element carries no copy of its own words -- a second copy is a copy that can\ndisagree with the bytes on the screen beside it.", "properties": { "arguments_ref": { "default": "", "description": "where this call's arguments are in the recorded request, as a JSON pointer into `request.body` -- a JSON string for one vendor and an object for another, which is what was sent; empty when Core could not place them", "title": "Arguments Ref", "type": "string" }, "call_id": { "description": "the model's own id for this call, correlating it to result", "title": "Call Id", "type": "string" }, "name": { "description": "the tool the model asked for, as it named it", "title": "Name", "type": "string" } }, "required": [ "call_id", "name" ], "title": "ElementToolCall", "type": "object" }, "EmailDomainCreate": { "additionalProperties": false, "description": "Body of `POST .../email-domains`: one domain this organisation claims.", "properties": { "domain": { "description": "The email domain, such as 'jansen.nl'. Not a wildcard, not a top-level domain and not a shared mailbox domain", "maxLength": 253, "minLength": 3, "title": "Domain", "type": "string" } }, "required": [ "domain" ], "title": "EmailDomainCreate", "type": "object" }, "EmailDomainRead": { "description": "One email domain this organisation claims. Its sign-in providers link only addresses in a\ndomain it has proved it owns.", "properties": { "created_at": { "description": "When the domain was claimed", "format": "date-time", "title": "Created At", "type": "string" }, "domain": { "description": "The domain, lowercase, an internationalised name in its xn-- form", "title": "Domain", "type": "string" }, "object": { "const": "email_domain", "default": "email_domain", "description": "The object's type", "title": "Object", "type": "string" }, "proof_record_name": { "description": "The DNS name to publish the TXT record at that proves the domain", "title": "Proof Record Name", "type": "string" }, "proof_record_value": { "description": "The TXT record's value; publish it, then ask for the domain to be verified", "title": "Proof Record Value", "type": "string" }, "verified": { "description": "Whether the organisation has proved it owns the domain", "title": "Verified", "type": "boolean" }, "verified_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When it was proved; null while it is not", "title": "Verified At" } }, "required": [ "domain", "verified", "proof_record_name", "proof_record_value", "verified_at", "created_at" ], "title": "EmailDomainRead", "type": "object" }, "EntitlementRead": { "description": "One entitlement, as the API returns it.", "properties": { "created_at": { "description": "When it was written", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "The operator that wrote it", "title": "Created By", "type": "string" }, "ends_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When it ends; null for a fixed fee", "title": "Ends At" }, "id": { "description": "Entitlement id", "title": "Id", "type": "string" }, "live": { "description": "Whether it entitles a subscription right now: started, not ended, not revoked", "title": "Live", "type": "boolean" }, "object": { "default": "entitlement", "description": "The object's type", "title": "Object", "type": "string" }, "publication_id": { "description": "The publication it admits a subscription to", "title": "Publication Id", "type": "string" }, "reference": { "description": "The paying system's own reference, stored unread", "title": "Reference", "type": "string" }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When it was revoked, if it was", "title": "Revoked At" }, "starts_at": { "description": "When it begins", "format": "date-time", "title": "Starts At", "type": "string" }, "tenant_id": { "description": "The entitled organisation", "title": "Tenant Id", "type": "string" }, "updated_at": { "description": "When it last changed", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "publication_id", "starts_at", "ends_at", "revoked_at", "reference", "live", "created_by", "created_at", "updated_at" ], "title": "EntitlementRead", "type": "object" }, "EntityCreate": { "additionalProperties": false, "description": "Body of `POST /knowledge/graphs/{graph_id}/entities`.", "properties": { "aliases": { "description": "other names the entity goes by, each 1 to 512 characters", "items": { "maxLength": 512, "minLength": 1, "type": "string" }, "maxItems": 32, "title": "Aliases", "type": "array" }, "name": { "description": "the entity's name", "maxLength": 512, "minLength": 1, "title": "Name", "type": "string" }, "properties": { "additionalProperties": true, "description": "the entity's properties, checked against its type's schema; a type with identity keys needs a value for each", "title": "Properties", "type": "object" }, "type": { "description": "an entity type of the schema", "maxLength": 64, "minLength": 1, "title": "Type", "type": "string" } }, "required": [ "type", "name" ], "title": "EntityCreate", "type": "object" }, "EntityRead": { "description": "One entity, as the reader may see it.", "properties": { "aliases": { "description": "Other names it goes by", "items": { "type": "string" }, "title": "Aliases", "type": "array" }, "created_at": { "description": "When it was first written", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who first wrote it: a key's id, or `operator:`", "title": "Created By", "type": "string" }, "graph_id": { "description": "Owning graph id", "title": "Graph Id", "type": "string" }, "id": { "description": "Entity id", "title": "Id", "type": "string" }, "name": { "description": "The entity's name", "title": "Name", "type": "string" }, "object": { "const": "knowledge_graph.entity", "default": "knowledge_graph.entity", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "description": "`manual` or `extracted`", "enum": [ "manual", "extracted" ], "title": "Origin", "type": "string" }, "properties": { "additionalProperties": true, "description": "Its properties", "title": "Properties", "type": "object" }, "schema_version": { "description": "The schema version it was validated against", "title": "Schema Version", "type": "integer" }, "sources": { "description": "Up to five sources behind it that this reader may see; empty for a manual entity nothing was extracted into", "items": { "$ref": "#/components/schemas/FactSource" }, "title": "Sources", "type": "array" }, "type": { "description": "The entity's type", "title": "Type", "type": "string" }, "updated_at": { "description": "When it was last written", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "graph_id", "type", "name", "aliases", "properties", "origin", "schema_version", "sources", "created_by", "created_at", "updated_at" ], "title": "EntityRead", "type": "object" }, "EntityType": { "additionalProperties": false, "description": "One entity type of a schema version.", "properties": { "description": { "default": "", "description": "what belongs under the type; what an extraction model and a query-writing model read", "maxLength": 1024, "title": "Description", "type": "string" }, "identity_keys": { "description": "the property names whose values identify one entity of the type; empty identifies it by its normalised name", "items": { "type": "string" }, "maxItems": 8, "title": "Identity Keys", "type": "array" }, "name": { "description": "the type's name, unique within the schema (`Company`)", "pattern": "^[A-Z][A-Za-z0-9_]{0,63}$", "title": "Name", "type": "string" }, "properties": { "additionalProperties": true, "description": "a JSON Schema (Draft 2020-12) object describing the type's properties; its `properties` map names them. Only same-document `$ref`s resolve", "title": "Properties", "type": "object" } }, "required": [ "name" ], "title": "EntityType", "type": "object" }, "EntityUpdate": { "additionalProperties": false, "description": "Body of `PATCH /knowledge/graphs/{graph_id}/entities/{entity_id}`: an absent field is left\nalone. The type is not here: a fact of another type is another fact.", "properties": { "aliases": { "anyOf": [ { "items": { "maxLength": 512, "minLength": 1, "type": "string" }, "maxItems": 32, "type": "array" }, { "type": "null" } ], "description": "the new aliases, replacing the old", "title": "Aliases" }, "name": { "anyOf": [ { "maxLength": 512, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "the new name", "title": "Name" }, "properties": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the new properties, replacing the old, checked against the type", "title": "Properties" } }, "title": "EntityUpdate", "type": "object" }, "EntraSignInProviderCreate": { "additionalProperties": false, "description": "Microsoft Entra ID, held to the organisation's own directory.", "properties": { "client_id": { "description": "The client this organisation registered at its provider for signing in to this deployment", "maxLength": 255, "minLength": 1, "title": "Client Id", "type": "string" }, "client_secret": { "description": "That client's secret. Accepted on every write and never answered back; a replacement must carry it again", "format": "password", "maxLength": 2048, "minLength": 1, "title": "Client Secret", "type": "string", "writeOnly": true }, "directory_id": { "description": "The organisation's Entra directory (tenant) id; only accounts of that directory may sign in. Its ID tokens must carry the optional claims `email` and `xms_edov`", "format": "uuid", "title": "Directory Id", "type": "string" }, "display_name": { "anyOf": [ { "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "What the sign-in page calls this provider, when it names it at all", "title": "Display Name" }, "kind": { "const": "entra", "description": "Microsoft Entra ID sign-in", "title": "Kind", "type": "string" } }, "required": [ "client_id", "client_secret", "kind", "directory_id" ], "title": "EntraSignInProviderCreate", "type": "object" }, "ErrorDetail": { "additionalProperties": false, "description": "The `error` object inside the envelope.", "properties": { "message": { "description": "a safe, fixed-wording description of the failure; never a provider's own text and never anything belonging to another tenant", "title": "Message", "type": "string" }, "type": { "description": "the vendor's machine-readable error type", "enum": [ "invalid_request_error", "authentication_error", "permission_error", "not_found_error", "rate_limit_error", "api_error", "overloaded_error" ], "title": "Type", "type": "string" } }, "required": [ "type", "message" ], "title": "ErrorDetail", "type": "object" }, "ErrorEnvelope": { "additionalProperties": false, "description": "Anthropic's error body, field for field.", "properties": { "error": { "$ref": "#/components/schemas/ErrorDetail", "description": "what went wrong" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the id correlating this failure with its request", "title": "Request Id" }, "type": { "const": "error", "default": "error", "description": "the object's wire type", "title": "Type", "type": "string" } }, "required": [ "error" ], "title": "ErrorEnvelope", "type": "object" }, "EvaluationCreate": { "additionalProperties": false, "description": "Body of `POST /evaluations`: the suite and the agents it measures.", "properties": { "agents": { "description": "ids of the agents this suite measures; an evaluation names agents and nothing else", "items": { "type": "string" }, "maxItems": 16, "minItems": 1, "title": "Agents", "type": "array" }, "description": { "default": "", "description": "What this suite measures", "maxLength": 1024, "title": "Description", "type": "string" }, "judge_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "catalogue model id the judged checks run against; null uses the agent's own", "title": "Judge Model" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the suite, at most 16 KiB serialised: stored, returned and never read by Core; omitted or null stores {}", "title": "Metadata" }, "name": { "description": "Unique name within the tenant", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "title": "Name", "type": "string" }, "run_as_key_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "the key of this tenant every run of this suite acts as; null means the key queueing a run acts for itself, and a person then cannot queue one at all", "title": "Run As Key Id" } }, "required": [ "name", "agents" ], "title": "EvaluationCreate", "type": "object" }, "EvaluationRead": { "description": "A suite, as the API returns it: its own fields, the agents it measures, its scenarios in\norder, and the newest run per agent.\n\n`latest_runs` rides along so a console listing suites needs no second call per row to answer\n\"is this agent healthy\": it is one `DISTINCT ON (agent_id)` query, whatever its statuses.", "properties": { "agents": { "description": "The agents this suite measures", "items": { "$ref": "#/components/schemas/AgentLink" }, "title": "Agents", "type": "array" }, "created_at": { "description": "When the suite was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created the suite: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "description": { "description": "What this suite measures", "title": "Description", "type": "string" }, "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "id": { "description": "Suite id", "title": "Id", "type": "string" }, "judge_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Catalogue model id the judged checks run against, or null for the agent's own", "title": "Judge Model" }, "latest_runs": { "description": "The newest run per linked agent, whatever its status", "items": { "$ref": "#/components/schemas/RunSummary" }, "title": "Latest Runs", "type": "array" }, "latest_version": { "description": "The published version the suite's agents, judge and scenarios above are; 0 while every version is a draft, which only the management twin reads", "title": "Latest Version", "type": "integer" }, "metadata": { "additionalProperties": true, "default": {}, "description": "The opaque document attached to this suite; {} when none was set", "title": "Metadata", "type": "object" }, "name": { "description": "Unique name within the tenant", "title": "Name", "type": "string" }, "object": { "const": "evaluation", "default": "evaluation", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/OriginRead" }, { "type": "null" } ], "description": "The subscription that installed this suite, and the publication it came from; null for a suite this organisation wrote itself" }, "run_as_key": { "anyOf": [ { "$ref": "#/components/schemas/KeyLink" }, { "type": "null" } ], "description": "The key every run of this suite acts as, or null when it names none (or names one that has since been deleted)" }, "scenarios": { "description": "The suite's scenarios, in position order", "items": { "$ref": "#/components/schemas/ScenarioRead" }, "title": "Scenarios", "type": "array" }, "updated_at": { "description": "When the suite was last changed", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "name", "description", "judge_model", "latest_version", "created_by", "created_at", "updated_at" ], "title": "EvaluationRead", "type": "object" }, "EvaluationUpdate": { "additionalProperties": false, "description": "Body of `PATCH /evaluations/{id}`: every field optional, and absent means unchanged.\n\n`judge_model` and `run_as_key_id` are the two fields an explicit `null` means something by --\nthe first clears the suite's own judge back to each agent's model, the second clears the key\nits runs act as -- so the service reads `model_fields_set` rather than the value, exactly as\n`ApiConnectorUpdate` does. `agents`, when given, replaces the whole set rather than adding to\nit: a console's agent picker submits what it shows.", "properties": { "agents": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 16, "minItems": 1, "type": "array" }, { "type": "null" } ], "description": "the agents this suite measures, replacing the whole set", "title": "Agents" }, "description": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "New description", "title": "Description" }, "judge_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "new judge model; an explicit null clears it back to each agent's own model", "title": "Judge Model" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "new opaque document, replacing whatever is stored whole; omitted leaves it alone, and {} clears it", "title": "Metadata" }, "name": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "type": "string" }, { "type": "null" } ], "description": "New unique name within the tenant", "title": "Name" }, "run_as_key_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "the key every run of this suite acts as; an explicit null clears it, after which only a key queueing for itself can start one", "title": "Run As Key Id" } }, "title": "EvaluationUpdate", "type": "object" }, "EvaluationVersionCreate": { "additionalProperties": false, "description": "Body of `POST /evaluations/{id}/versions`: everything a version measures, written whole.", "properties": { "agents": { "description": "ids of the agents this version measures", "items": { "type": "string" }, "maxItems": 16, "minItems": 1, "title": "Agents", "type": "array" }, "judge_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "catalogue model id the judged checks run against; null uses each turn's own", "title": "Judge Model" }, "scenarios": { "description": "every scenario of this version; a scenario left out is removed", "items": { "$ref": "#/components/schemas/ScenarioVersionWrite" }, "maxItems": 32, "title": "Scenarios", "type": "array" } }, "required": [ "agents" ], "title": "EvaluationVersionCreate", "type": "object" }, "EvaluationVersionRead": { "description": "One version of a suite, as the API returns it.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "agent_ids": { "description": "The ids of the agents this version measures", "items": { "type": "string" }, "title": "Agent Ids", "type": "array" }, "created_at": { "description": "When the version was written", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who wrote the version: a key's id, `operator:` for a person, or null for the version recorded from a suite that predates versions", "title": "Created By" }, "evaluation_id": { "description": "The suite this version belongs to", "title": "Evaluation Id", "type": "string" }, "judge_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Catalogue model id the judged checks run against, or null for each turn's own", "title": "Judge Model" }, "object": { "const": "evaluation.version", "default": "evaluation.version", "description": "The object's type", "title": "Object", "type": "string" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "scenarios": { "description": "Every scenario of this version, in position order; steps empty for a sealed copy", "items": { "$ref": "#/components/schemas/ScenarioRead" }, "title": "Scenarios", "type": "array" }, "state": { "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" } }, "required": [ "evaluation_id", "version", "state", "published_at", "judge_model", "agent_ids", "created_by", "acted_for", "created_at" ], "title": "EvaluationVersionRead", "type": "object" }, "EvaluationsConfig": { "additionalProperties": false, "description": "The `evaluations` capability: stored suites an agent is measured against. No configuration,\nand one dependency -- `agents`, because an evaluation names agents and nothing else\n(`docs/architecture/evaluations.md`).", "properties": {}, "title": "EvaluationsConfig", "type": "object" }, "EventSubscriptionCreate": { "additionalProperties": false, "description": "A webhook to register.", "properties": { "kinds": { "description": "The event types to deliver; empty or absent for every type", "items": { "enum": [ "thread.item.created", "response.completed", "response.failed", "response.incomplete", "response.cancelled", "response.check_failed", "run.suspended", "run.resumed", "run.approval.requested", "run.approval.decided", "thread.task.started", "thread.task.completed", "thread.task.failed", "thread.task.cancelled", "thread.task.expired", "knowledge.source.created", "knowledge.source.updated", "knowledge.source.deleted", "knowledge.source.restored", "knowledge.source.ingested", "knowledge.index.reindex_requested", "knowledge.index.reindexed", "knowledge.connector.synced", "memory.commitment_overdue", "mail.received", "improvements.proposal.created", "improvements.analysis.finished", "workflow.run.started", "workflow.run.completed", "workflow.run.failed", "workflow.run.cancelled", "workflow.run.expired", "workflow.decision.requested", "workflow.decision.decided", "workflow.decision.expired", "datastore.record.written", "datastore.record.deleted", "usage.threshold_reached", "usage.cap_exceeded" ], "type": "string" }, "maxItems": 32, "title": "Kinds", "type": "array" }, "url": { "description": "Where each event is POSTed, decided as every destination an organisation chooses is: refused when it is an address on a private network, when the deployment blocks the host, when the organisation's allowed hosts or this key's own rules over `egress_host` do not permit it, or, for a key whose policy names regions_allow, when host_regions does not place the host in one of them and no residency exception names it", "format": "uri", "minLength": 1, "title": "Url", "type": "string" }, "vendor": { "anyOf": [ { "$ref": "#/components/schemas/VendorOrigin" }, { "type": "null" } ], "description": "who runs this host, as you state it: where the company serving it is established (`established_in`) and where that company's ultimate parent is (`parent_in`), each a zone ('eu', 'us', 'global') or an ISO 3166-1 alpha-2 country code, never 'in-cluster'. A key or organisation whose `policy.settings.vendors_allow` names places reaches the host only when they contain what is stated; a fact left out is 'global', which only a requirement naming 'global' admits" } }, "required": [ "url" ], "title": "EventSubscriptionCreate", "type": "object" }, "EventSubscriptionRead": { "description": "One webhook subscription. The signing secret is never shown here.", "properties": { "created_at": { "description": "When the subscription was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "The actor that created the subscription", "title": "Created By", "type": "string" }, "id": { "description": "Subscription id", "title": "Id", "type": "string" }, "key_id": { "description": "The key that subscribed; its current policy decides each delivery", "title": "Key Id", "type": "string" }, "kinds": { "description": "The event types delivered; empty for every type", "items": { "enum": [ "thread.item.created", "response.completed", "response.failed", "response.incomplete", "response.cancelled", "response.check_failed", "run.suspended", "run.resumed", "run.approval.requested", "run.approval.decided", "thread.task.started", "thread.task.completed", "thread.task.failed", "thread.task.cancelled", "thread.task.expired", "knowledge.source.created", "knowledge.source.updated", "knowledge.source.deleted", "knowledge.source.restored", "knowledge.source.ingested", "knowledge.index.reindex_requested", "knowledge.index.reindexed", "knowledge.connector.synced", "memory.commitment_overdue", "mail.received", "improvements.proposal.created", "improvements.analysis.finished", "workflow.run.started", "workflow.run.completed", "workflow.run.failed", "workflow.run.cancelled", "workflow.run.expired", "workflow.decision.requested", "workflow.decision.decided", "workflow.decision.expired", "datastore.record.written", "datastore.record.deleted", "usage.threshold_reached", "usage.cap_exceeded" ], "type": "string" }, "title": "Kinds", "type": "array" }, "url": { "description": "Where each event is POSTed", "maxLength": 2048, "title": "Url", "type": "string" }, "vendor": { "$ref": "#/components/schemas/VendorOrigin", "description": "who runs this host, as its registrant stated it; each fact null where nobody did, which `policy.settings.vendors_allow` reads as 'global'" } }, "required": [ "id", "url", "kinds", "vendor", "key_id", "created_by", "created_at" ], "title": "EventSubscriptionRead", "type": "object" }, "EventSubscriptionSecret": { "description": "A subscription with its signing secret, answered exactly twice: when it is created and\nwhen its secret is rotated. Core cannot show it again.", "properties": { "created_at": { "description": "When the subscription was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "The actor that created the subscription", "title": "Created By", "type": "string" }, "id": { "description": "Subscription id", "title": "Id", "type": "string" }, "key_id": { "description": "The key that subscribed; its current policy decides each delivery", "title": "Key Id", "type": "string" }, "kinds": { "description": "The event types delivered; empty for every type", "items": { "enum": [ "thread.item.created", "response.completed", "response.failed", "response.incomplete", "response.cancelled", "response.check_failed", "run.suspended", "run.resumed", "run.approval.requested", "run.approval.decided", "thread.task.started", "thread.task.completed", "thread.task.failed", "thread.task.cancelled", "thread.task.expired", "knowledge.source.created", "knowledge.source.updated", "knowledge.source.deleted", "knowledge.source.restored", "knowledge.source.ingested", "knowledge.index.reindex_requested", "knowledge.index.reindexed", "knowledge.connector.synced", "memory.commitment_overdue", "mail.received", "improvements.proposal.created", "improvements.analysis.finished", "workflow.run.started", "workflow.run.completed", "workflow.run.failed", "workflow.run.cancelled", "workflow.run.expired", "workflow.decision.requested", "workflow.decision.decided", "workflow.decision.expired", "datastore.record.written", "datastore.record.deleted", "usage.threshold_reached", "usage.cap_exceeded" ], "type": "string" }, "title": "Kinds", "type": "array" }, "secret": { "description": "The key every delivery is signed with (`Artific-Signature`); store it now, it is not shown again", "title": "Secret", "type": "string" }, "url": { "description": "Where each event is POSTed", "maxLength": 2048, "title": "Url", "type": "string" }, "vendor": { "$ref": "#/components/schemas/VendorOrigin", "description": "who runs this host, as its registrant stated it; each fact null where nobody did, which `policy.settings.vendors_allow` reads as 'global'" } }, "required": [ "id", "url", "kinds", "vendor", "key_id", "created_by", "created_at", "secret" ], "title": "EventSubscriptionSecret", "type": "object" }, "EvidenceRead": { "description": "One turn, or one memory record, a proposal rests on, as ids; follow `response_id` to its\ntrace, or `memory_id` to the record.", "properties": { "memory_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The memory record a promotion proposal rests on; null for a turn", "title": "Memory Id" }, "observed_at": { "description": "When the turn happened, or when the memory record last changed", "format": "date-time", "title": "Observed At", "type": "string" }, "response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The turn; null when the proposal rests on a memory record", "title": "Response Id" }, "subject_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the turn was for, when it named one", "title": "Subject Id" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The turn's thread, when it had one", "title": "Thread Id" } }, "required": [ "response_id", "thread_id", "subject_id", "observed_at" ], "title": "EvidenceRead", "type": "object" }, "ExportCreate": { "additionalProperties": false, "description": "Body of `POST /tenants/{tenant_id}/exports` and its key-facing twins.", "properties": { "subject": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Narrow the archive to one person's rows, by the id the calling application named them with -- what answers GDPR Articles 15 and 20. Leave it out for the whole organisation", "title": "Subject" } }, "title": "ExportCreate", "type": "object" }, "ExportRead": { "description": "One export, as both surfaces return it.", "properties": { "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the archive became ready", "title": "Completed At" }, "counts": { "additionalProperties": { "type": "integer" }, "description": "Rows per file and files written, as the archive's manifest states them", "title": "Counts", "type": "object" }, "created_at": { "description": "When it was asked for", "format": "date-time", "title": "Created At", "type": "string" }, "downloads": { "description": "How many downloads were started", "title": "Downloads", "type": "integer" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why the last attempt failed, as an exception type or a fixed code; never a message", "title": "Error" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the archive is deleted; the download answers 409 from then on", "title": "Expires At" }, "id": { "description": "Export id", "title": "Id", "type": "string" }, "object": { "const": "export", "default": "export", "description": "The object's type", "title": "Object", "type": "string" }, "requested_by": { "description": "Who asked: a key id, or operator: for a person", "title": "Requested By", "type": "string" }, "sha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SHA-256 hex digest of the archive, once ready", "title": "Sha256" }, "size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The archive's length in bytes, once ready", "title": "Size Bytes" }, "status": { "description": "queued, running, ready (downloadable), failed (retried by the worker) or expired (deleted)", "enum": [ "queued", "running", "ready", "failed", "expired", "erased" ], "title": "Status", "type": "string" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The one person the archive is narrowed to, or null for the whole organisation", "title": "Subject" }, "tenant_id": { "description": "The organisation exported", "title": "Tenant Id", "type": "string" }, "withheld": { "description": "What the archive leaves out: the surfaces this organisation's parent reserved from whoever asked ('audit', 'usage'), and 'drafts' when a key asked, since no key sees a draft", "items": { "type": "string" }, "title": "Withheld", "type": "array" } }, "required": [ "id", "tenant_id", "subject", "status", "requested_by", "withheld", "counts", "size_bytes", "sha256", "error", "downloads", "created_at", "completed_at", "expires_at" ], "title": "ExportRead", "type": "object" }, "FactSource": { "description": "A source behind a fact that the reader may see: enough for a console to link it and a\ncitation to name it.", "properties": { "collection_id": { "description": "The collection the source belongs to", "title": "Collection Id", "type": "string" }, "id": { "description": "Source id", "title": "Id", "type": "string" }, "title": { "description": "The source's title", "title": "Title", "type": "string" } }, "required": [ "id", "collection_id", "title" ], "title": "FactSource", "type": "object" }, "FieldFilter": { "additionalProperties": false, "description": "One condition of a record query, with the whole operator set; `RecordFilter` is the subset\na knowledge table takes. Several are read as *and*.", "properties": { "field": { "description": "the field the condition reads", "maxLength": 256, "minLength": 1, "title": "Field", "type": "string" }, "op": { "description": "`eq`, `ne`, `lt`, `lte`, `gt`, `gte` compare; `contains`, `starts_with` and `ends_with` match a string field literally and case-insensitively; `in` matches any value of a list; `exists` asks whether the field holds a value at all", "enum": [ "eq", "ne", "lt", "lte", "gt", "gte", "contains", "starts_with", "ends_with", "in", "exists" ], "title": "Op", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "minItems": 1, "type": "array" } ], "description": "what the field is held against, read as the field's type: a list (at most 100 values) for `in` and only for `in`, true or false for `exists`, a string for the three text matches", "title": "Value" } }, "required": [ "field", "op", "value" ], "title": "FieldFilter", "type": "object" }, "FileCitation": { "additionalProperties": false, "description": "A passage of this tenant's own content the answer cited, at the marker that cited it.", "properties": { "file_id": { "description": "id of the chunk the passage came from", "title": "File Id", "type": "string" }, "filename": { "description": "the knowledge source's name, or the chunk id when none was recorded", "title": "Filename", "type": "string" }, "index": { "description": "offset of the marker in the text this annotates, in Unicode code points (not UTF-8 bytes, not UTF-16 units)", "title": "Index", "type": "integer" }, "type": { "const": "file_citation", "default": "file_citation", "description": "the annotation's kind", "title": "Type", "type": "string" } }, "required": [ "file_id", "filename", "index" ], "title": "FileCitation", "type": "object" }, "FileRead": { "description": "A file's metadata, as the files API returns it.\n\nNever declares `blob_id`: the blob is an internal storage detail, not part of the identity a\ncaller acts on (`app.blobs.facts`'s docstring says where `bytes` and `sha256` come\nfrom instead).", "properties": { "bytes": { "description": "Size in bytes", "title": "Bytes", "type": "integer" }, "call_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tool call that produced this file, for an artifact", "title": "Call Id" }, "collection_id": { "description": "Knowledge collection this file lives in: the calling key's own collection unless the upload named another", "title": "Collection Id", "type": "string" }, "created_at": { "description": "When the file was uploaded", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who uploaded the file: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "deleted_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this file was deleted into the trash, where every read but the trash's own listing skips it; null while it is live", "title": "Deleted At" }, "filename": { "description": "Caller-supplied filename", "title": "Filename", "type": "string" }, "folder": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The folder this file sits in, a normalised `/`-separated path such as `contracts/2026`; null at the collection's root", "title": "Folder" }, "id": { "description": "File id", "title": "Id", "type": "string" }, "index_error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why this file's ingestion failed, as the fixed code its index's sources listing carries (`embedding_unavailable` when the deployment has no embedding model for this organisation, `needs_ocr`, `too_large` ...); set only while index_status is 'failed', null otherwise", "title": "Index Error Code" }, "index_status": { "anyOf": [ { "enum": [ "queued", "processing", "ready", "failed" ], "type": "string" }, { "type": "null" } ], "description": "How far this file's own ingestion has got, over every index that draws it in: 'ready' when it can be searched, 'queued' or 'processing' while it is still being ingested, 'failed' when it could not be; null when no index holds it", "title": "Index Status" }, "kind": { "description": "What this stored file is: 'file' an upload, 'artifact' bytes a tool produced during a turn, 'text', 'records' or 'connector' a knowledge document", "enum": [ "file", "artifact", "text", "records", "connector" ], "title": "Kind", "type": "string" }, "labels": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "the labels the rules over this row's kind read, as label -> a value or a list of values, read back exactly as written", "title": "Labels", "type": "object" }, "media_type": { "description": "MIME type of the file's content", "title": "Media Type", "type": "string" }, "object": { "const": "file", "default": "file", "description": "The object's type", "title": "Object", "type": "string" }, "parked_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Set while this file's ingestion is held at the monthly cost cap: it stays 'queued' until this instant, the start of the next month (UTC), or until the cap is raised or lifted, whichever comes first; null when nothing holds it", "title": "Parked Until" }, "purge_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the trash purges this file with its bytes, unless it is restored first; null while it is live", "title": "Purge At" }, "purpose": { "description": "Caller-chosen label for the file's purpose; opaque to Core", "title": "Purpose", "type": "string" }, "response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Response whose turn produced this file, for an artifact", "title": "Response Id" }, "retention": { "description": "'window' if the organisation's retention window covers this file, 'keep' if it stays until something deletes it", "enum": [ "window", "keep" ], "title": "Retention", "type": "string" }, "sha256": { "description": "SHA-256 hex digest of the file's content", "title": "Sha256", "type": "string" }, "tool_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the tool that produced this file, for an artifact", "title": "Tool Name" }, "updated_at": { "description": "When the file's name, retention, folder or collection last changed; its creation time until then", "format": "date-time", "title": "Updated At", "type": "string" }, "viewable": { "description": "Whether this file can be opened as a page: true for an upload or an artifact stored as `text/html`, false for everything else, a knowledge document included. A view, a share link and a page are refused `409` for a file that says false", "title": "Viewable", "type": "boolean" } }, "required": [ "id", "kind", "filename", "purpose", "labels", "bytes", "media_type", "sha256", "viewable", "collection_id", "retention", "created_by", "created_at", "updated_at" ], "title": "FileRead", "type": "object" }, "FileSource": { "additionalProperties": false, "description": "A Core file by id -- this surface's one extension to a vendor block.\n\nAnthropic's own `file` source names a file of *its* Files API; Core has its own\n(`POST /files`), and an id is the only thing either side could mean here.", "properties": { "file_id": { "description": "id of a file previously uploaded to Core", "title": "File Id", "type": "string" }, "type": { "const": "file", "default": "file", "description": "image source kind", "title": "Type", "type": "string" } }, "required": [ "file_id" ], "title": "FileSource", "type": "object" }, "FileSourceCreate": { "additionalProperties": false, "description": "Body of `POST /knowledge/collections/{id}/sources` for `kind: \"file\"`: **a copy** of bytes\nthis tenant already holds into this collection.\n\n`file_id` names an upload or an artifact -- both are sources\n(`docs/architecture/files-and-artifacts.md`) -- which must exist for this tenant with the\n`files` capability effective and be one this caller reaches (404, identical either way). The\nbytes are copied into a blob the new source owns, so deleting either leaves the other alone,\nand the copy's title comes from the original's. A file the caller has *not* uploaded yet goes\nin with one call instead: `POST .../sources/upload` carries the bytes themselves.\n\nThe media type decides the source's shape -- `text/plain`, `text/markdown`, `text/html`,\n`application/pdf` and the Word and PowerPoint formats are unstructured, `text/csv`,\n`application/json` and the Excel format are structured -- or is refused with 422 for any\nother media type. A format nothing decodes on its own (HTML, PDF, Office) needs a pipeline\nwith a node that reads it, or its ingestion fails with `needs_parse`; the default templates\ncarry one.", "properties": { "file_id": { "description": "Id of the file or artifact whose bytes are copied in", "minLength": 1, "title": "File Id", "type": "string" }, "kind": { "const": "file", "description": "Source kind", "title": "Kind", "type": "string" }, "labels": { "default": {}, "description": "labels the rules over this row's kind read, as label -> a value or a list of 1 to 32 distinct values, each of 1 to 256 characters; at most 32 names. Held to the organisation's vocabulary and, for a request naming a person, to `writable_labels`", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "additionalProperties": { "maxLength": 2048, "type": "string" }, "description": "Metadata matched by a search's metadata filter", "maxProperties": 64, "propertyNames": { "maxLength": 128 }, "title": "Metadata", "type": "object" } }, "required": [ "kind", "file_id" ], "title": "FileSourceCreate", "type": "object" }, "FileTarget": { "description": "A session that ends as a file, as `POST /files` stores one.", "properties": { "collection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The collection the file lands in; the calling key's own when absent, the organisation's `uploads` collection for a person", "title": "Collection Id" }, "folder": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "the folder the file is put in, a `/`-separated path normalised by Core; empty or absent puts it at the collection's root", "title": "Folder" }, "kind": { "const": "file", "description": "The session ends as a file", "title": "Kind", "type": "string" }, "labels": { "default": {}, "description": "labels the rules over this row's kind read, as label -> a value or a list of 1 to 32 distinct values, each of 1 to 256 characters; at most 32 names. Held to the organisation's vocabulary and, for a request naming a person, to `writable_labels`", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "purpose": { "description": "Caller-chosen label for the file's purpose", "maxLength": 64, "minLength": 1, "title": "Purpose", "type": "string" }, "retention": { "anyOf": [ { "enum": [ "window", "keep" ], "type": "string" }, { "type": "null" } ], "description": "'keep' keeps the file past the organisation's retention window; the collection's default when absent", "title": "Retention" } }, "required": [ "kind", "purpose" ], "title": "FileTarget", "type": "object" }, "FileUpdate": { "additionalProperties": false, "description": "Body of `PATCH /files/{file_id}`; absent fields are left alone. A file's bytes and kind\nare fixed for its whole life, so neither is here.", "properties": { "collection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The collection to move the file into: only between collections that hold files, a key's own and the organisation's `uploads`, and only one the caller reaches, else `422`. Its retention stays its own", "title": "Collection Id" }, "filename": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "New filename, stripped to its last path component; an upload's must be one the caller's rules over `file` permit", "title": "Filename" }, "folder": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "The folder to move the file into, a `/`-separated path Core normalises; empty or `/` moves it to the collection's root. A synced document's folder is its origin's, so changing it is `409`", "title": "Folder" }, "retention": { "anyOf": [ { "enum": [ "window", "keep" ], "type": "string" }, { "type": "null" } ], "description": "'window' lets the organisation's retention window take the file once it is older than the window, 'keep' keeps it until something deletes it", "title": "Retention" } }, "title": "FileUpdate", "type": "object" }, "FilesConfig": { "additionalProperties": false, "description": "The `files` capability: ceiling on uploaded file size, and whether what this key stores is\nsearchable.", "properties": { "index_uploads": { "default": true, "description": "whether the key's own collection is indexed so an upload is searchable on the next turn; effective only when `knowledge` is effective for the key", "title": "Index Uploads", "type": "boolean" }, "max_bytes": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "largest file this key may upload; None uses the operator ceiling at use", "title": "Max Bytes" } }, "title": "FilesConfig", "type": "object" }, "FixtureConnectorConfig": { "additionalProperties": false, "description": "Inline documents, accepted only where `Settings.environment` is `local` or `test`: what\nproves the whole connector path end to end without reaching any network, the way the `echo`\nmodel proves a turn.", "properties": { "exclude_path_regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Items whose path matches this are skipped, on top of the built-in media/binary exclusion, which always applies and is never replaced", "title": "Exclude Path Regex" }, "fail_with": { "anyOf": [ { "enum": [ "auth_failed", "not_found", "rate_limited", "egress_denied", "too_many_items", "provider_error", "cancelled", "deadline_exceeded", "region_denied", "tenant_unavailable" ], "type": "string" }, { "type": "null" } ], "description": "When set, this connector's `discover` fails immediately with this code -- makes a sync fail on demand, in an e2e journey or a runbook drill, without a vendor to fail against. Accepted for `fixture` only, the same way the kind itself is", "title": "Fail With" }, "include_path_regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Only items whose path matches this are synced; null matches all", "title": "Include Path Regex" }, "items": { "description": "The documents this connector offers", "items": { "$ref": "#/components/schemas/FixtureItem" }, "maxItems": 1000, "title": "Items", "type": "array" }, "kind": { "const": "fixture", "description": "Connector kind", "title": "Kind", "type": "string" } }, "required": [ "kind" ], "title": "FixtureConnectorConfig", "type": "object" }, "FixtureItem": { "additionalProperties": false, "description": "One inline document a `fixture` connector offers.", "properties": { "folder": { "default": "", "description": "`/`-separated path under the connector's root", "maxLength": 512, "title": "Folder", "type": "string" }, "media_type": { "default": "text/markdown", "description": "Media type of `text`", "maxLength": 255, "title": "Media Type", "type": "string" }, "text": { "default": "", "description": "The item's content", "maxLength": 65536, "title": "Text", "type": "string" }, "uri": { "description": "Stable identity of this item", "maxLength": 512, "minLength": 1, "title": "Uri", "type": "string" } }, "required": [ "uri" ], "title": "FixtureItem", "type": "object" }, "FolderMoveCreate": { "additionalProperties": false, "description": "Body of `POST /files/folders/move`: a folder renamed or moved, by moving every row the\ncaller reaches at `from` or beneath it to the same place under `to`.", "properties": { "collection_id": { "description": "The collection whose folder moves", "title": "Collection Id", "type": "string" }, "from": { "description": "The folder to move, a `/`-separated path Core normalises; not the root", "maxLength": 1024, "title": "From", "type": "string" }, "to": { "description": "Where it goes, normalised the same way; empty or `/` is the root. Never `from` itself or beneath it", "maxLength": 1024, "title": "To", "type": "string" } }, "required": [ "collection_id", "from", "to" ], "title": "FolderMoveCreate", "type": "object" }, "FolderMoveRead": { "description": "What one folder move did, with both paths as Core normalised them: the caller learns\nwhere the rows now are without listing them again.", "properties": { "collection_id": { "description": "The collection whose folder moved", "title": "Collection Id", "type": "string" }, "from": { "description": "The folder that moved, normalised", "title": "From", "type": "string" }, "moved": { "description": "How many rows moved: those the caller reaches, at `from` or beneath it", "title": "Moved", "type": "integer" }, "object": { "const": "folder_move", "default": "folder_move", "description": "The object's type", "title": "Object", "type": "string" }, "to": { "description": "Where it went, normalised; empty for the root", "title": "To", "type": "string" } }, "required": [ "collection_id", "from", "to", "moved" ], "title": "FolderMoveRead", "type": "object" }, "FunctionCallInput": { "additionalProperties": false, "description": "A `function_call` replayed on the request: the model's own prior call.", "properties": { "arguments": { "description": "the call's arguments, as emitted (JSON text)", "title": "Arguments", "type": "string" }, "call_id": { "description": "id correlating this call with its function_call_output", "maxLength": 128, "minLength": 1, "title": "Call Id", "type": "string" }, "caller": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the context that produced the call; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Caller" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the item's id; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Id" }, "name": { "description": "the tool name that was called", "pattern": "^[A-Za-z0-9_-]{1,64}$", "title": "Name", "type": "string" }, "namespace": { "anyOf": [ { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "type": "string" }, { "type": "null" } ], "description": "the `namespace` tools[] entry the called tool belongs to, as Core answered it: the call is replayed to the model under the one flattened name it was offered, `ns___`", "title": "Namespace" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the item's status; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Status" }, "type": { "const": "function_call", "default": "function_call", "description": "input item kind", "title": "Type", "type": "string" } }, "required": [ "call_id", "name", "arguments" ], "title": "FunctionCallInput", "type": "object" }, "FunctionCallOutput": { "additionalProperties": false, "description": "A call on a tool the *caller* executes: Core forwards it and waits for the result.", "properties": { "arguments": { "description": "the call's arguments, as emitted (JSON text)", "title": "Arguments", "type": "string" }, "call_id": { "description": "id correlating this call with its result", "title": "Call Id", "type": "string" }, "id": { "description": "the item's id", "title": "Id", "type": "string" }, "name": { "description": "the tool's name; inside its namespace, when it has one", "title": "Name", "type": "string" }, "namespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the `namespace` tools[] entry the called tool belongs to, so the caller routes the call to the tool it declared; null for a tool offered on its own", "title": "Namespace" }, "status": { "const": "completed", "default": "completed", "description": "the item's completion status", "title": "Status", "type": "string" }, "type": { "const": "function_call", "default": "function_call", "description": "output item kind", "title": "Type", "type": "string" } }, "required": [ "id", "call_id", "name", "arguments" ], "title": "FunctionCallOutput", "type": "object" }, "FunctionCallOutputInput": { "additionalProperties": false, "description": "A `function_call_output` submitted on the request: a client tool's result.", "properties": { "call_id": { "description": "id correlating this output with its function_call", "title": "Call Id", "type": "string" }, "caller": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the context that produced the output; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Caller" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the item's id; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the tool's name; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Name" }, "namespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the tool's namespace; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Namespace" }, "output": { "anyOf": [ { "maxLength": 1048576, "type": "string" }, { "items": { "discriminator": { "mapping": { "input_image": "#/components/schemas/InputImagePart", "input_text": "#/components/schemas/InputTextPart" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/InputTextPart" }, { "$ref": "#/components/schemas/InputImagePart" } ] }, "type": "array" } ], "description": "the tool's output: its text, at most 1 MiB, or a list of `input_text` and `input_image` parts whose text, joined, is at most 1 MiB. An image is read by the model as the tool's data, never as the user's", "title": "Output" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the item's status; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Status" }, "type": { "const": "function_call_output", "default": "function_call_output", "description": "input item kind", "title": "Type", "type": "string" } }, "required": [ "call_id", "output" ], "title": "FunctionCallOutputInput", "type": "object" }, "FunctionCreate": { "additionalProperties": false, "description": "Body of `POST /functions`: the function and its version 1.", "properties": { "description": { "description": "What the tool does, shown to the model", "maxLength": 1024, "minLength": 1, "title": "Description", "type": "string" }, "fuel_limit": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "The fuel one call may burn, roughly one unit per WebAssembly instruction, at most the deployment's `functions_fuel_max`; null takes the deployment's default", "title": "Fuel Limit" }, "memory_limit_bytes": { "anyOf": [ { "minimum": 65536.0, "type": "integer" }, { "type": "null" } ], "description": "The linear memory one call may hold, at most the deployment's `functions_memory_max_bytes`; null takes the deployment's default", "title": "Memory Limit Bytes" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the function, at most 16 KiB: stored, returned and never read by Core. Omitted on a new version keeps the function's", "title": "Metadata" }, "module": { "anyOf": [ { "maxLength": 22369624, "type": "string" }, { "type": "null" } ], "description": "The WebAssembly module, base64-encoded, for one small enough to fit a JSON body; give this or `module_file_id`, never both", "title": "Module" }, "module_file_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "An upload this caller may read (`POST /files`) holding the module, copied into the version; for a module of any size up to the deployment's limit", "title": "Module File Id" }, "name": { "description": "Function name, unique per organisation and never changed; the model sees `function__`", "pattern": "^[a-z0-9_-]{1,48}$", "title": "Name", "type": "string" }, "output_schema": { "additionalProperties": true, "description": "JSON Schema object (Draft 2020-12, at most 64 KiB) the module's output document must satisfy, or for a version with reads or writes its `result`; an output that does not is an invalid output", "title": "Output Schema", "type": "object" }, "parameters": { "additionalProperties": true, "description": "JSON Schema object (Draft 2020-12, at most 64 KiB) the call's arguments must satisfy; the module reads them as the input document's `arguments`", "title": "Parameters", "type": "object" }, "reads": { "description": "The records Core reads for each call before the module runs, in order, under the caller's own scope; the module finds them in the input document's `reads`. A version with reads or writes returns `{result, operations}` and is never cached", "items": { "discriminator": { "mapping": { "record": "#/components/schemas/DeclaredRecord", "records": "#/components/schemas/DeclaredRecords" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/DeclaredRecord" }, { "$ref": "#/components/schemas/DeclaredRecords" } ] }, "maxItems": 8, "title": "Reads", "type": "array" }, "writes": { "description": "The datastores, by name, the operations a call returns may write; an operation on any other refuses the call", "items": { "description": "A datastore's name", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "type": "string" }, "maxItems": 16, "title": "Writes", "type": "array" } }, "required": [ "description", "name" ], "title": "FunctionCreate", "type": "object" }, "FunctionRead": { "description": "One function, with the fields of the version it shows flat and that version's number.", "properties": { "created_at": { "description": "When this function was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created this function", "title": "Created By", "type": "string" }, "description": { "description": "What the tool does, from the version shown", "title": "Description", "type": "string" }, "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "fuel_limit": { "description": "The fuel one call of the version may burn", "title": "Fuel Limit", "type": "integer" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "id": { "description": "Function id", "title": "Id", "type": "string" }, "memory_limit_bytes": { "description": "The linear memory one call may hold, in bytes", "title": "Memory Limit Bytes", "type": "integer" }, "metadata": { "additionalProperties": true, "description": "The opaque document attached; {} when none", "title": "Metadata", "type": "object" }, "module_sha256": { "description": "SHA-256 hex digest of the version's module", "title": "Module Sha256", "type": "string" }, "module_size_bytes": { "description": "The version's module length in bytes", "title": "Module Size Bytes", "type": "integer" }, "name": { "description": "Function name; the model sees `function__`", "title": "Name", "type": "string" }, "object": { "const": "function", "default": "function", "description": "The object's type", "title": "Object", "type": "string" }, "output_schema": { "additionalProperties": true, "description": "The version's output schema", "title": "Output Schema", "type": "object" }, "parameters": { "additionalProperties": true, "description": "The version's argument schema", "title": "Parameters", "type": "object" }, "reads": { "description": "The records the version reads, declared", "items": { "discriminator": { "mapping": { "record": "#/components/schemas/DeclaredRecord", "records": "#/components/schemas/DeclaredRecords" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/DeclaredRecord" }, { "$ref": "#/components/schemas/DeclaredRecords" } ] }, "title": "Reads", "type": "array" }, "state": { "default": "published", "description": "The state of the version this read repeats: `draft` only on the management twin, for a function with nothing published", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "updated_at": { "description": "When this function last gained a published version", "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "description": "This function's latest published version number, whose fields this read repeats; on the management twin, its newest draft's while nothing is published", "title": "Version", "type": "integer" }, "writes": { "description": "The datastores the version may write", "items": { "type": "string" }, "title": "Writes", "type": "array" } }, "required": [ "id", "name", "description", "parameters", "output_schema", "reads", "writes", "module_sha256", "module_size_bytes", "fuel_limit", "memory_limit_bytes", "version", "metadata", "created_by", "created_at", "updated_at" ], "title": "FunctionRead", "type": "object" }, "FunctionToolEcho": { "additionalProperties": false, "description": "A `function` tool the request offered, as it was accepted.", "properties": { "description": { "description": "the tool's description", "title": "Description", "type": "string" }, "name": { "description": "the tool's name", "title": "Name", "type": "string" }, "parameters": { "additionalProperties": true, "description": "JSON Schema for the tool's arguments", "title": "Parameters", "type": "object" }, "strict": { "description": "whether the model must follow parameters exactly", "title": "Strict", "type": "boolean" }, "type": { "const": "function", "default": "function", "description": "tool kind", "title": "Type", "type": "string" } }, "required": [ "name", "description", "parameters", "strict" ], "title": "FunctionToolEcho", "type": "object" }, "FunctionToolParam": { "additionalProperties": false, "description": "A client-supplied function tool: the kernel executes it, Core only forwards the call.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "the vendor's tool-search hint: `true` on any entry of a request puts the whole call behind the tool router, as `tool_search` `router` would, never this tool alone; Core's own `tool_search` wins over it", "title": "Defer Loading" }, "description": { "default": "", "description": "the tool's description, at most 16384 characters", "maxLength": 16384, "title": "Description", "type": "string" }, "name": { "description": "the tool's name", "title": "Name", "type": "string" }, "parameters": { "additionalProperties": true, "default": { "properties": {}, "type": "object" }, "description": "JSON Schema for the tool's arguments", "title": "Parameters", "type": "object" }, "strict": { "default": false, "description": "require the model to follow parameters exactly", "title": "Strict", "type": "boolean" }, "type": { "const": "function", "default": "function", "description": "tool param kind", "title": "Type", "type": "string" } }, "required": [ "name" ], "title": "FunctionToolParam", "type": "object" }, "FunctionVersionCreate": { "additionalProperties": false, "description": "Body of `POST /functions/{function_id}/versions`: the whole next version.", "properties": { "description": { "description": "What the tool does, shown to the model", "maxLength": 1024, "minLength": 1, "title": "Description", "type": "string" }, "fuel_limit": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "The fuel one call may burn, roughly one unit per WebAssembly instruction, at most the deployment's `functions_fuel_max`; null takes the deployment's default", "title": "Fuel Limit" }, "memory_limit_bytes": { "anyOf": [ { "minimum": 65536.0, "type": "integer" }, { "type": "null" } ], "description": "The linear memory one call may hold, at most the deployment's `functions_memory_max_bytes`; null takes the deployment's default", "title": "Memory Limit Bytes" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the function, at most 16 KiB: stored, returned and never read by Core. Omitted on a new version keeps the function's", "title": "Metadata" }, "module": { "anyOf": [ { "maxLength": 22369624, "type": "string" }, { "type": "null" } ], "description": "The WebAssembly module, base64-encoded, for one small enough to fit a JSON body; give this or `module_file_id`, never both", "title": "Module" }, "module_file_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "An upload this caller may read (`POST /files`) holding the module, copied into the version; for a module of any size up to the deployment's limit", "title": "Module File Id" }, "output_schema": { "additionalProperties": true, "description": "JSON Schema object (Draft 2020-12, at most 64 KiB) the module's output document must satisfy, or for a version with reads or writes its `result`; an output that does not is an invalid output", "title": "Output Schema", "type": "object" }, "parameters": { "additionalProperties": true, "description": "JSON Schema object (Draft 2020-12, at most 64 KiB) the call's arguments must satisfy; the module reads them as the input document's `arguments`", "title": "Parameters", "type": "object" }, "reads": { "description": "The records Core reads for each call before the module runs, in order, under the caller's own scope; the module finds them in the input document's `reads`. A version with reads or writes returns `{result, operations}` and is never cached", "items": { "discriminator": { "mapping": { "record": "#/components/schemas/DeclaredRecord", "records": "#/components/schemas/DeclaredRecords" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/DeclaredRecord" }, { "$ref": "#/components/schemas/DeclaredRecords" } ] }, "maxItems": 8, "title": "Reads", "type": "array" }, "writes": { "description": "The datastores, by name, the operations a call returns may write; an operation on any other refuses the call", "items": { "description": "A datastore's name", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "type": "string" }, "maxItems": 16, "title": "Writes", "type": "array" } }, "required": [ "description" ], "title": "FunctionVersionCreate", "type": "object" }, "FunctionVersionRead": { "description": "One version of a function.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "created_at": { "description": "When this version was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created this version", "title": "Created By", "type": "string" }, "description": { "description": "What the tool does, shown to the model", "title": "Description", "type": "string" }, "fuel_limit": { "description": "The fuel one call may burn", "title": "Fuel Limit", "type": "integer" }, "function_id": { "description": "Function this version belongs to", "title": "Function Id", "type": "string" }, "memory_limit_bytes": { "description": "The linear memory one call may hold, in bytes", "title": "Memory Limit Bytes", "type": "integer" }, "module_sha256": { "description": "SHA-256 hex digest of the module's bytes", "title": "Module Sha256", "type": "string" }, "module_size_bytes": { "description": "The module's length in bytes", "title": "Module Size Bytes", "type": "integer" }, "object": { "const": "function_version", "default": "function_version", "description": "The object's type", "title": "Object", "type": "string" }, "output_schema": { "additionalProperties": true, "description": "JSON Schema of the output document", "title": "Output Schema", "type": "object" }, "parameters": { "additionalProperties": true, "description": "JSON Schema object for the call's arguments", "title": "Parameters", "type": "object" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "reads": { "description": "The records Core reads before each call runs, as the version declared them", "items": { "discriminator": { "mapping": { "record": "#/components/schemas/DeclaredRecord", "records": "#/components/schemas/DeclaredRecords" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/DeclaredRecord" }, { "$ref": "#/components/schemas/DeclaredRecords" } ] }, "title": "Reads", "type": "array" }, "state": { "default": "published", "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" }, "writes": { "description": "The datastores the version's operations may write", "items": { "type": "string" }, "title": "Writes", "type": "array" } }, "required": [ "function_id", "version", "description", "parameters", "output_schema", "reads", "writes", "module_sha256", "module_size_bytes", "fuel_limit", "memory_limit_bytes", "created_by", "acted_for", "created_at" ], "title": "FunctionVersionRead", "type": "object" }, "GoogleDriveConnectorConfig": { "additionalProperties": false, "description": "One Google Drive folder, over the Drive REST API as a service account.", "properties": { "drive_id": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "type": "null" } ], "description": "Shared Drive id, when the folder lives in one", "title": "Drive Id" }, "exclude_path_regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Items whose path matches this are skipped, on top of the built-in media/binary exclusion, which always applies and is never replaced", "title": "Exclude Path Regex" }, "folder_id": { "description": "Root Drive folder id", "maxLength": 256, "minLength": 1, "title": "Folder Id", "type": "string" }, "include_path_regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Only items whose path matches this are synced; null matches all", "title": "Include Path Regex" }, "kind": { "const": "gdrive", "description": "Connector kind", "title": "Kind", "type": "string" }, "service_account_json": { "anyOf": [ { "maxLength": 16384, "type": "string" }, { "type": "null" } ], "description": "Service-account key JSON; write-only, sealed at rest and never returned", "title": "Service Account Json" } }, "required": [ "kind", "folder_id" ], "title": "GoogleDriveConnectorConfig", "type": "object" }, "GoogleSignInProviderCreate": { "additionalProperties": false, "description": "Google Workspace, held to one of the organisation's own domains.", "properties": { "client_id": { "description": "The client this organisation registered at its provider for signing in to this deployment", "maxLength": 255, "minLength": 1, "title": "Client Id", "type": "string" }, "client_secret": { "description": "That client's secret. Accepted on every write and never answered back; a replacement must carry it again", "format": "password", "maxLength": 2048, "minLength": 1, "title": "Client Secret", "type": "string", "writeOnly": true }, "display_name": { "anyOf": [ { "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "What the sign-in page calls this provider, when it names it at all", "title": "Display Name" }, "hosted_domain": { "description": "The Workspace domain whose accounts may sign in; an account of any other domain, or a personal Google account, is refused", "maxLength": 253, "pattern": "^([a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$", "title": "Hosted Domain", "type": "string" }, "kind": { "const": "google", "description": "Google Workspace sign-in", "title": "Kind", "type": "string" } }, "required": [ "client_id", "client_secret", "kind", "hosted_domain" ], "title": "GoogleSignInProviderCreate", "type": "object" }, "GraphCreate": { "additionalProperties": false, "description": "Body of `POST /knowledge/graphs`.", "properties": { "collection_ids": { "description": "the collections the graph draws sources from, each with an optional metadata filter; at most 16. A `shared` graph never draws in a source a person owns", "items": { "$ref": "#/components/schemas/IndexCollectionLink" }, "title": "Collection Ids", "type": "array" }, "description": { "default": "", "description": "what the graph holds", "maxLength": 1024, "title": "Description", "type": "string" }, "embedding_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "catalogue embedding model id its entities are embedded with; null uses the deployment default", "title": "Embedding Model" }, "ingest_pipeline": { "anyOf": [ { "$ref": "#/components/schemas/PipelineRef" }, { "type": "null" } ], "description": "the ingest pipeline that fills the graph from its sources: a version, or a built-in `graph/...` template; it must end in `graph_store`. Null draws no source in" }, "labels": { "default": {}, "description": "The organisation's classification of this graph, as label -> value; what the rules over `knowledge_graph` read", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "additionalProperties": true, "default": {}, "description": "an opaque document the application attaches to this row, at most 16 KiB serialised: stored, returned and never read by Core or its rules", "title": "Metadata", "type": "object" }, "name": { "description": "unique name within the organisation; what a policy glob names it by, and never changed afterwards", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "title": "Name", "type": "string" }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/GraphSchemaWrite" }, { "type": "null" } ], "description": "the first schema version, written with the graph; absent or null leaves the graph without one, and without facts, until `PUT .../schema`" }, "visibility": { "description": "`shared`: draws in only sources owned by no person, and every reader sees every fact; `per_person`: a fact is shown to a person when one of its sources is visible to her. Fixed at create", "enum": [ "shared", "per_person" ], "title": "Visibility", "type": "string" } }, "required": [ "name", "visibility" ], "title": "GraphCreate", "type": "object" }, "GraphEntityHit": { "description": "One entity a graph step reached, as the reader it ran for sees it\n(`app.knowledge.graphs.visibility`): her visible mentions' name and values, and only sources\nshe may read.", "properties": { "aliases": { "description": "other names it goes by, as this reader sees them", "items": { "type": "string" }, "title": "Aliases", "type": "array" }, "id": { "description": "the entity's id", "title": "Id", "type": "string" }, "name": { "description": "its name, as this reader sees it", "title": "Name", "type": "string" }, "origin": { "description": "`manual` (the organisation's own record) or `extracted`", "enum": [ "manual", "extracted" ], "title": "Origin", "type": "string" }, "properties": { "additionalProperties": true, "description": "its properties, as this reader sees them", "title": "Properties", "type": "object" }, "sources": { "description": "up to five sources behind it this reader may read; empty for a manual fact", "items": { "$ref": "#/components/schemas/FactSource" }, "title": "Sources", "type": "array" }, "type": { "description": "its entity type", "title": "Type", "type": "string" } }, "required": [ "id", "type", "name", "aliases", "properties", "origin", "sources" ], "title": "GraphEntityHit", "type": "object" }, "GraphHit": { "description": "What one graph step found in one graph: the entities and relations it reached, and for a\n`graph_query` the paths and the typed query Core validated. A run carries these beside its\nranked `hits` -- which hold only the facts a source behind them can cite -- so a manual fact,\nwhich has none, still reaches the model, as untrusted structured content\n(`docs/architecture/knowledge-graphs.md`, \"Searching a graph\").", "properties": { "entities": { "description": "every entity reached, once", "items": { "$ref": "#/components/schemas/GraphEntityHit" }, "title": "Entities", "type": "array" }, "graph_id": { "description": "the graph that was read", "title": "Graph Id", "type": "string" }, "paths": { "description": "a `graph_query`'s paths as ids: the start entity, then a relation and an entity per step; empty for a `graph_search`", "items": { "items": { "type": "string" }, "type": "array" }, "title": "Paths", "type": "array" }, "query": { "anyOf": [ { "$ref": "#/components/schemas/GraphQuery" }, { "type": "null" } ], "description": "the typed query a `graph_query` ran, as Core validated it; null for a `graph_search`" }, "relations": { "description": "every relation reached, once", "items": { "$ref": "#/components/schemas/GraphRelationHit" }, "title": "Relations", "type": "array" }, "truncated": { "default": false, "description": "true when a cap or the limit cut the answer short", "title": "Truncated", "type": "boolean" } }, "required": [ "graph_id", "entities", "relations" ], "title": "GraphHit", "type": "object" }, "GraphQuery": { "additionalProperties": false, "description": "Body of `POST /knowledge/graphs/{graph_id}/query`: a start, up to three steps, a limit.", "properties": { "follow": { "description": "at most three steps, taken in order", "items": { "$ref": "#/components/schemas/GraphStep" }, "maxItems": 3, "title": "Follow", "type": "array" }, "limit": { "default": 100, "description": "the most paths returned; bounded here, not only at each caller, since a model may fill the form", "maximum": 500.0, "minimum": 1.0, "title": "Limit", "type": "integer" }, "start": { "$ref": "#/components/schemas/GraphStart", "description": "the entities the traversal begins from" } }, "required": [ "start" ], "title": "GraphQuery", "type": "object" }, "GraphQueryArgs": { "additionalProperties": false, "description": "A graph query the model calling a tool built itself: which offered graph, and the\n`GraphQuery` over it. What a `graph_query` step in `arguments` mode runs, after checking the\ngraph is one it offered and the query fits that graph's latest schema -- the gate a caller's\nown query goes through (`docs/architecture/knowledge-graphs.md`, \"Validation\").", "properties": { "follow": { "description": "at most three steps, taken in order", "items": { "$ref": "#/components/schemas/GraphStep" }, "maxItems": 3, "title": "Follow", "type": "array" }, "graph_id": { "description": "the offered graph to query", "maxLength": 64, "minLength": 1, "title": "Graph Id", "type": "string" }, "limit": { "default": 100, "description": "the most paths returned; bounded here, not only at each caller, since a model may fill the form", "maximum": 500.0, "minimum": 1.0, "title": "Limit", "type": "integer" }, "start": { "$ref": "#/components/schemas/GraphStart", "description": "the entities the traversal begins from" } }, "required": [ "start", "graph_id" ], "title": "GraphQueryArgs", "type": "object" }, "GraphQueryResult": { "description": "What a query reached: the entities and relations on its paths, the paths as sequences of\nids, and whether a cap cut it short.", "properties": { "entities": { "description": "Every entity on a returned path, once", "items": { "$ref": "#/components/schemas/EntityRead" }, "title": "Entities", "type": "array" }, "paths": { "description": "Each path as ids: the start entity, then a relation and an entity per step", "items": { "items": { "type": "string" }, "type": "array" }, "title": "Paths", "type": "array" }, "relations": { "description": "Every relation on a returned path, once", "items": { "$ref": "#/components/schemas/RelationRead" }, "title": "Relations", "type": "array" }, "truncated": { "description": "true when a fan-out cap or the limit cut the answer short, so it is partial", "title": "Truncated", "type": "boolean" } }, "required": [ "entities", "relations", "paths", "truncated" ], "title": "GraphQueryResult", "type": "object" }, "GraphRead": { "description": "A graph, as the API returns it.", "properties": { "collection_ids": { "description": "The collections the graph draws sources from", "items": { "$ref": "#/components/schemas/IndexCollectionLink" }, "title": "Collection Ids", "type": "array" }, "created_at": { "description": "When it was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created it: a key's id, or `operator:`", "title": "Created By", "type": "string" }, "description": { "description": "What the graph holds", "title": "Description", "type": "string" }, "embedding_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Catalogue embedding model id its entities use, when set", "title": "Embedding Model" }, "epoch": { "default": 0, "description": "Bumped when its ingest pipeline or embedding model changes", "title": "Epoch", "type": "integer" }, "id": { "description": "Graph id", "title": "Id", "type": "string" }, "ingest_pipeline": { "anyOf": [ { "$ref": "#/components/schemas/PipelineRef" }, { "type": "null" } ], "description": "The ingest pipeline that fills it, when set" }, "labels": { "description": "The organisation's classification of this graph", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "latest_schema_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The version facts are validated against now; null while it has none", "title": "Latest Schema Version" }, "metadata": { "additionalProperties": true, "description": "The opaque document attached to it", "title": "Metadata", "type": "object" }, "name": { "description": "Unique name within the organisation", "title": "Name", "type": "string" }, "object": { "const": "knowledge_graph", "default": "knowledge_graph", "description": "The object's type", "title": "Object", "type": "string" }, "reindex_required": { "default": false, "description": "true only on the answer to a write that changed what the graph's extraction is asked for -- a new schema version, another pipeline or embedding model -- and nothing is re-extracted on its own", "title": "Reindex Required", "type": "boolean" }, "updated_at": { "description": "When its description, labels or schema changed", "format": "date-time", "title": "Updated At", "type": "string" }, "visibility": { "description": "`shared` or `per_person`, fixed at create", "enum": [ "shared", "per_person" ], "title": "Visibility", "type": "string" } }, "required": [ "id", "name", "description", "visibility", "labels", "metadata", "latest_schema_version", "created_by", "created_at", "updated_at" ], "title": "GraphRead", "type": "object" }, "GraphRelationHit": { "description": "One relation a graph step reached, as the reader it ran for sees it.", "properties": { "from_entity_id": { "description": "the entity it leaves", "title": "From Entity Id", "type": "string" }, "id": { "description": "the relation's id", "title": "Id", "type": "string" }, "origin": { "description": "`manual` (the organisation's own record) or `extracted`", "enum": [ "manual", "extracted" ], "title": "Origin", "type": "string" }, "properties": { "additionalProperties": true, "description": "its properties, as this reader sees them", "title": "Properties", "type": "object" }, "sources": { "description": "up to five sources behind it this reader may read; empty for a manual fact", "items": { "$ref": "#/components/schemas/FactSource" }, "title": "Sources", "type": "array" }, "to_entity_id": { "description": "the entity it reaches", "title": "To Entity Id", "type": "string" }, "type": { "description": "its relation type", "title": "Type", "type": "string" } }, "required": [ "id", "type", "from_entity_id", "to_entity_id", "properties", "origin", "sources" ], "title": "GraphRelationHit", "type": "object" }, "GraphRunRead": { "description": "One reindex of one graph.", "properties": { "created_at": { "description": "When this run was created", "format": "date-time", "title": "Created At", "type": "string" }, "epoch": { "description": "The graph epoch this run extracts sources under", "title": "Epoch", "type": "integer" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Fixed code: 'all_sources_failed' or 'stalled' when failed, 'superseded' when cancelled because the target moved to a newer epoch under the run", "title": "Error Code" }, "finished_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this run finished", "title": "Finished At" }, "graph_id": { "description": "Graph this run re-extracts", "title": "Graph Id", "type": "string" }, "id": { "description": "Graph run id", "title": "Id", "type": "string" }, "object": { "const": "knowledge_graph_run", "default": "knowledge_graph_run", "description": "The object's type", "title": "Object", "type": "string" }, "sources_done": { "description": "Sources that finished (ready or failed), or were deleted or re-routed away while the run was under way", "title": "Sources Done", "type": "integer" }, "sources_failed": { "description": "Sources that finished failed", "title": "Sources Failed", "type": "integer" }, "sources_total": { "description": "Sources this run covers", "title": "Sources Total", "type": "integer" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this run began executing", "title": "Started At" }, "status": { "description": "This run's current status", "enum": [ "queued", "running", "completed", "failed", "cancelled" ], "title": "Status", "type": "string" }, "trigger": { "description": "What started this run and in which mode: 'manual:full' re-extracts every source in scope, 'manual:failed' retries the pairs whose last ingestion failed", "title": "Trigger", "type": "string" } }, "required": [ "id", "graph_id", "trigger", "status", "epoch", "sources_total", "sources_done", "sources_failed", "created_at" ], "title": "GraphRunRead", "type": "object" }, "GraphSchemaAssistRead": { "description": "What the graph schema helper drafted. Nothing is stored: the caller decides whether it goes\nto `PUT /knowledge/graphs/{id}/schema` or a graph's create.", "properties": { "explanation": { "description": "What the schema models and why, in a few sentences of the model's own, for the person deciding whether to use it", "title": "Explanation", "type": "string" }, "model": { "description": "The catalogue chat model that wrote it", "title": "Model", "type": "string" }, "object": { "const": "assist.graph_schema", "default": "assist.graph_schema", "description": "The object's type", "title": "Object", "type": "string" }, "sample": { "description": "The sources the model was shown, newest first -- what it saw, not what it said; empty when no collection was named", "items": { "$ref": "#/components/schemas/SampledSourceRead" }, "title": "Sample", "type": "array" }, "schema": { "$ref": "#/components/schemas/GraphSchemaWrite", "description": "The drafted schema, in exactly the body a graph's schema write takes and checked by the check that write makes" } }, "required": [ "schema", "explanation", "model", "sample" ], "title": "GraphSchemaAssistRead", "type": "object" }, "GraphSchemaAssistRequest": { "additionalProperties": false, "description": "Body of `POST /assist/graph-schema` and its management twin.", "properties": { "collection_id": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "description": "A knowledge collection whose documents show what the graph will hold: the most recent sources the caller reaches are read (at most `sample_size`, each cut to 4,000 characters) and sent to the helper model as data. `404` for a collection the caller does not reach", "title": "Collection Id" }, "current_schema": { "anyOf": [ { "$ref": "#/components/schemas/GraphSchemaWrite" }, { "type": "null" } ], "description": "A schema to start from and change as the description and the sample ask; omit it to write one from nothing. At most as large as a datastore's schema may be" }, "description": { "anyOf": [ { "maxLength": 4000, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "What the graph should hold, in plain language -- the kinds of thing and how they relate. Sent to the organisation's helper model as data, never as an instruction. At least one of this and `collection_id` is required", "title": "Description" }, "sample_size": { "default": 5, "description": "How many of the collection's most recent sources to read, 1 to 5. Ignored without `collection_id`", "maximum": 5.0, "minimum": 1.0, "title": "Sample Size", "type": "integer" } }, "title": "GraphSchemaAssistRequest", "type": "object" }, "GraphSchemaVersionRead": { "description": "One immutable schema version.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "created_at": { "description": "When it was written", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who wrote it: a key's id, or `operator:`", "title": "Created By", "type": "string" }, "entity_types": { "description": "The entity types", "items": { "$ref": "#/components/schemas/EntityType" }, "title": "Entity Types", "type": "array" }, "graph_id": { "description": "Owning graph id", "title": "Graph Id", "type": "string" }, "id": { "description": "Schema version id", "title": "Id", "type": "string" }, "object": { "const": "knowledge_graph.schema_version", "default": "knowledge_graph.schema_version", "description": "The object's type", "title": "Object", "type": "string" }, "relation_types": { "description": "The relation types", "items": { "$ref": "#/components/schemas/RelationType" }, "title": "Relation Types", "type": "array" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" } }, "required": [ "id", "graph_id", "version", "entity_types", "relation_types", "created_by", "acted_for", "created_at" ], "title": "GraphSchemaVersionRead", "type": "object" }, "GraphSchemaWrite": { "additionalProperties": false, "description": "Body of `PUT /knowledge/graphs/{graph_id}/schema`: the entity and relation types every\nfact written from now on is checked against. A body equal to the latest version writes\nnothing.", "properties": { "entity_types": { "description": "the entity types, at most 50", "items": { "$ref": "#/components/schemas/EntityType" }, "maxItems": 50, "minItems": 1, "title": "Entity Types", "type": "array" }, "relation_types": { "description": "the relation types, at most 100", "items": { "$ref": "#/components/schemas/RelationType" }, "maxItems": 100, "title": "Relation Types", "type": "array" } }, "required": [ "entity_types" ], "title": "GraphSchemaWrite", "type": "object" }, "GraphStart": { "additionalProperties": false, "description": "Where a traversal begins: the entities of one type, by id, by name, or all of them, each\nnarrowed by property filters.", "properties": { "filters": { "description": "property filters, ANDed", "items": { "$ref": "#/components/schemas/RecordFilter" }, "maxItems": 16, "title": "Filters", "type": "array" }, "ids": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 200, "minItems": 1, "type": "array" }, { "type": "null" } ], "description": "the entities to start from, by id; not with `name`", "title": "Ids" }, "name": { "anyOf": [ { "maxLength": 512, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "a name matched over names and aliases, exact normalised matches first, the last word also as a prefix; not with `ids`", "title": "Name" }, "type": { "description": "the entity type to start from", "maxLength": 64, "minLength": 1, "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "GraphStart", "type": "object" }, "GraphStep": { "additionalProperties": false, "description": "One hop: follow a relation type in a direction to the entities it reaches.", "properties": { "direction": { "default": "out", "description": "`out` along the relation, `in` against it, `both` either way", "enum": [ "out", "in", "both" ], "title": "Direction", "type": "string" }, "filters": { "description": "filters over the reached entity's properties, ANDed", "items": { "$ref": "#/components/schemas/RecordFilter" }, "maxItems": 16, "title": "Filters", "type": "array" }, "relation": { "anyOf": [ { "maxLength": 64, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "the relation type to follow; null follows every type, the costly shape", "title": "Relation" }, "relation_filters": { "description": "filters over the followed relation's own properties, ANDed", "items": { "$ref": "#/components/schemas/RecordFilter" }, "maxItems": 16, "title": "Relation Filters", "type": "array" }, "to_type": { "anyOf": [ { "maxLength": 64, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "the entity type to reach", "title": "To Type" } }, "title": "GraphStep", "type": "object" }, "GraphUpdate": { "additionalProperties": false, "description": "Body of `PATCH /knowledge/graphs/{graph_id}`: an absent field is left alone. Neither the\nname nor the visibility is here: a glob names the graph by the one, and the other decides\nwhich facts it may ever have held. `ingest_pipeline` and `embedding_model` are nullable\ntargets, so an explicit null clears them while an absent field leaves them; changing either\nbumps the epoch and answers `reindex_required: true`.", "properties": { "collection_ids": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IndexCollectionLink" }, "type": "array" }, { "type": "null" } ], "description": "the collections the graph draws from, replacing the current set; a source it stops drawing in keeps its facts until a full reindex", "title": "Collection Ids" }, "description": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "the new description", "title": "Description" }, "embedding_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "catalogue embedding model id; null uses the deployment default", "title": "Embedding Model" }, "ingest_pipeline": { "anyOf": [ { "$ref": "#/components/schemas/PipelineRef" }, { "type": "null" } ], "description": "the ingest pipeline; null clears it and draws nothing in" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "new classification of this graph, replacing whatever is stored; omitted leaves it, {} clears it", "title": "Labels" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "an opaque document the application attaches to this row, at most 16 KiB serialised: stored, returned and never read by Core or its rules; replaces it whole, {} clears it", "title": "Metadata" } }, "title": "GraphUpdate", "type": "object" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "title": "Detail", "type": "array" } }, "title": "HTTPValidationError", "type": "object" }, "HealthRead": { "description": "The liveness payload: this process is up, running this build.", "properties": { "status": { "const": "ok", "description": "always \"ok\"; the route has no dependency that could fail it", "title": "Status", "type": "string" }, "version": { "description": "the running build: the artific-core release, and the commit it was built from when the image carries one (`0.1.0+g9f3c1dd`)", "title": "Version", "type": "string" } }, "required": [ "status", "version" ], "title": "HealthRead", "type": "object" }, "Hit": { "description": "One ranked result a node produced: a chunk a search found, a whole document a\ncollection block read (`chunk_id` and `index_id` null), or a fact a graph step found, cited to\none source behind it (`chunk_id` and `index_id` null, `graph_id` and `fact_id` set). An image\nhit has empty `text` and an `image`.", "properties": { "chunk_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the matched chunk's id; null for a whole document read from a collection", "title": "Chunk Id" }, "fact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the entity or relation a fact hit states; null for a chunk or a document", "title": "Fact Id" }, "graph_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the knowledge graph a fact hit came from; null otherwise", "title": "Graph Id" }, "image": { "anyOf": [ { "$ref": "#/components/schemas/HitImage" }, { "type": "null" } ], "description": "the picture this hit is, when it is an image chunk" }, "index_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the chunk's index; null for a whole document read from a collection", "title": "Index Id" }, "level": { "default": 0, "description": "the chunk's hierarchy level", "title": "Level", "type": "integer" }, "metadata": { "additionalProperties": true, "description": "the chunk's metadata", "title": "Metadata", "type": "object" }, "score": { "description": "this node's ranking score", "title": "Score", "type": "number" }, "source_id": { "description": "the source this hit's text comes from", "title": "Source Id", "type": "string" }, "source_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the title of the source this hit comes from, when it has one and the step that found the hit read it", "title": "Source Title" }, "text": { "description": "the chunk's text", "title": "Text", "type": "string" } }, "required": [ "chunk_id", "source_id", "index_id", "score", "text" ], "title": "Hit", "type": "object" }, "HitImage": { "description": "The picture an image hit is, as a link rather than bytes: a search answer never carries\nan image inline, and reading one goes through the same route, the same visibility and the\nsame trail as reading anything else of the source's (`GET .../chunks/{chunk_id}/image`).", "properties": { "media_type": { "description": "the picture's media type", "title": "Media Type", "type": "string" }, "path": { "description": "where the picture is read, relative to the API root this search was made on: `/knowledge/indexes/{index_id}/chunks/{chunk_id}/image`", "title": "Path", "type": "string" } }, "required": [ "media_type", "path" ], "title": "HitImage", "type": "object" }, "HostAccess": { "additionalProperties": false, "description": "One host a source or a bundle would reach, and whether this organisation may reach it.\n\nA value embedded in other reads, not a resource of its own, so it has no `Create`/`Update`\nforms and no id.", "properties": { "allowed": { "description": "Whether the organisation's own allowed hosts permit this host: some rule over `egress_host` of its policy document permits it and none forbids it, and every organisation above that holds a rule over `egress_host` permits it too. False for an organisation that wrote no document", "title": "Allowed", "type": "boolean" }, "blocked": { "description": "Whether the deployment refuses this host for every organisation: its block list names it, it is itself a loopback, link-local, metadata or private address, or it is a name that only names something inside a network (`localhost`, a single label such as a cluster service, an ending of `.svc`, `.local`, `.internal`, `.localhost` or `.cluster.local`, an address in a legacy spelling such as `2130706433`). A blocked host is refused whatever the organisation allows", "title": "Blocked", "type": "boolean" }, "host": { "description": "The hostname, lowercase, with no scheme, port or path", "title": "Host", "type": "string" } }, "required": [ "host", "allowed", "blocked" ], "title": "HostAccess", "type": "object" }, "HostingRequirement": { "additionalProperties": false, "description": "Where the model answering this turn must run (Core extension).", "properties": { "region": { "description": "required hosting region: a jurisdiction ('eu', 'us', 'in-cluster', 'global') or an ISO 3166-1 alpha-2 country code ('nl'). Satisfied by a model hosted inside it -- places nest, so 'eu' contains 'in-cluster' and every member state, and 'global' contains everything; a model that does not satisfy it is refused before the provider is called", "pattern": "^(eu|us|in-cluster|global|[a-z]{2})$", "title": "Region", "type": "string" } }, "required": [ "region" ], "title": "HostingRequirement", "type": "object" }, "HttpRequestTemplate": { "additionalProperties": false, "description": "The request an API connector sends instead of the fixed contract, as its tenant configured\nit. Every check here is one the template can fail on its own; the checks that need the\nconnector's `http_url` and `parameters` are `check_url` and `check_template`.", "properties": { "body": { "$ref": "#/components/schemas/JsonValue", "description": "JSON body whose strings may carry `{argument}` placeholders; a string that is exactly one placeholder keeps the argument's own type. Null sends no body at all, and a body is only allowed with POST, PUT and PATCH" }, "headers": { "additionalProperties": { "type": "string" }, "description": "Request headers; values may be `{argument}` templates, and a value that is exactly one placeholder whose argument is absent omits the entry. proxy-authorization and cookie, and a header Core or the transport sets, are refused; authorization is accepted only when the connector's auth is none", "maxProperties": 32, "title": "Headers", "type": "object" }, "method": { "default": "POST", "description": "HTTP method used for the call", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "title": "Method", "type": "string" }, "query": { "additionalProperties": { "type": "string" }, "description": "Query parameters merged onto the connector's http_url; keys are literal text, values may be `{argument}` templates. A value that is exactly one placeholder whose argument is absent omits the entry", "maxProperties": 64, "title": "Query", "type": "object" }, "timeout": { "anyOf": [ { "exclusiveMinimum": 0.0, "maximum": 300.0, "type": "number" }, { "type": "null" } ], "description": "Seconds this call may take; the effective budget is the smaller of this and the deployment's own tool timeout. Null means the deployment's budget", "title": "Timeout" } }, "title": "HttpRequestTemplate", "type": "object" }, "ImageBlockIn": { "additionalProperties": false, "description": "An `image` block: inline base64, or a Core `file_id`.", "properties": { "cache_control": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the vendor's prompt-cache hint; accepted and ignored: a hint that does not change what the answer means, so it is neither refused nor forwarded, stored or echoed", "title": "Cache Control" }, "source": { "description": "where the image's bytes come from", "discriminator": { "mapping": { "base64": "#/components/schemas/Base64ImageSource", "file": "#/components/schemas/FileSource" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/Base64ImageSource" }, { "$ref": "#/components/schemas/FileSource" } ], "title": "Source" }, "type": { "const": "image", "default": "image", "description": "content block kind", "title": "Type", "type": "string" } }, "required": [ "source" ], "title": "ImageBlockIn", "type": "object" }, "ImprovementModelRead": { "description": "Which model this organisation's analyses call, or that none is in force.", "properties": { "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The catalogue chat model analyses call; null when neither the organisation nor the deployment names one, and every reading that needs a model is then skipped", "title": "Model" }, "object": { "const": "improvement_model", "default": "improvement_model", "description": "The object's type", "title": "Object", "type": "string" }, "source": { "anyOf": [ { "enum": [ "organisation", "deployment" ], "type": "string" }, { "type": "null" } ], "description": "'organisation' when the organisation chose it (analysis_model), 'deployment' when it follows the deployment's default; null when there is none", "title": "Source" } }, "required": [ "model", "source" ], "title": "ImprovementModelRead", "type": "object" }, "ImprovementSettingsRead": { "description": "The organisation's improvement settings as they stand, every check included.", "properties": { "apply_level": { "additionalProperties": { "enum": [ "propose", "draft", "publish" ], "type": "string" }, "description": "Every proposal kind by name, and how far an analysis applies it by itself: `propose`, `draft` or `publish`", "title": "Apply Level", "type": "object" }, "apply_levels_offered": { "additionalProperties": { "items": { "enum": [ "propose", "draft", "publish" ], "type": "string" }, "type": "array" }, "description": "Every proposal kind by name, and the levels `apply_level` takes for it, least first: what a settings form offers", "title": "Apply Levels Offered", "type": "object" }, "checks": { "additionalProperties": { "$ref": "#/components/schemas/CheckSettings" }, "description": "Every check this deployment runs, by name, with what it is held to", "title": "Checks", "type": "object" }, "cron": { "description": "Five-field cron expression the analyses run on", "title": "Cron", "type": "string" }, "dismiss_quiet_days": { "description": "How long a dismissed finding stays quiet", "title": "Dismiss Quiet Days", "type": "integer" }, "enabled": { "description": "Whether analyses run at all", "title": "Enabled", "type": "boolean" }, "last_month": { "$ref": "#/components/schemas/ImprovementUsageRead", "description": "What last month's analyses did" }, "max_model_calls": { "description": "Model calls one analysis may make", "title": "Max Model Calls", "type": "integer" }, "next_run_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the next analysis is due; null while analyses are off", "title": "Next Run At" }, "object": { "const": "improvement_settings", "default": "improvement_settings", "description": "The object's type", "title": "Object", "type": "string" }, "pseudonymisation": { "$ref": "#/components/schemas/DetectionSettings", "description": "What the reading hides" }, "timezone": { "description": "IANA zone the cron expression is read in", "title": "Timezone", "type": "string" }, "trial_key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The key a trial's runs act as, whose monthly cap is the trials' budget; null queues no trial", "title": "Trial Key Id" }, "window_days": { "description": "How many days back an analysis reads", "title": "Window Days", "type": "integer" } }, "required": [ "enabled", "cron", "timezone", "next_run_at", "window_days", "checks", "pseudonymisation", "max_model_calls", "dismiss_quiet_days", "apply_level", "apply_levels_offered", "trial_key_id", "last_month" ], "title": "ImprovementSettingsRead", "type": "object" }, "ImprovementSettingsUpdate": { "additionalProperties": false, "description": "A change to the settings; a field left out keeps what it has.", "properties": { "apply_level": { "anyOf": [ { "additionalProperties": { "enum": [ "propose", "draft", "publish" ], "type": "string" }, "type": "object" }, { "type": "null" } ], "description": "Per proposal kind by name, how far an analysis applies its proposals by itself: `propose` (only propose), `draft` (write a draft a person publishes) or `publish` (write it and publish it); a kind not named keeps what it has. An agent or a prompt kind takes all three, a skill kind and `memory_shared_fact` `propose` or `publish`, any other kind `propose` only", "title": "Apply Level" }, "checks": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/CheckSettingsUpdate" }, "type": "object" }, { "type": "null" } ], "description": "Per check by name, what changes from what it has; a check not named keeps its settings", "title": "Checks" }, "cron": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "type": "null" } ], "description": "Five-field cron expression the analyses run on", "title": "Cron" }, "dismiss_quiet_days": { "anyOf": [ { "maximum": 365.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "How long a dismissed finding stays quiet", "title": "Dismiss Quiet Days" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether analyses run at all", "title": "Enabled" }, "max_model_calls": { "anyOf": [ { "maximum": 500.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "description": "Model calls one analysis may make", "title": "Max Model Calls" }, "pseudonymisation": { "anyOf": [ { "$ref": "#/components/schemas/DetectionSettings" }, { "type": "null" } ], "description": "What the reading hides; send null to return to the capability's defaults. The reading is always pseudonymised" }, "timezone": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "IANA zone the cron expression is read in", "title": "Timezone" }, "trial_key_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "The key of the organisation a trial's runs act as, whose monthly cap is the trials' budget; a key of another organisation is 422. Send null to name none, which queues no trial", "title": "Trial Key Id" }, "window_days": { "anyOf": [ { "maximum": 30.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "How many days back an analysis reads, 1 to 30", "title": "Window Days" } }, "title": "ImprovementSettingsUpdate", "type": "object" }, "ImprovementUsageRead": { "description": "What last calendar month's analyses did.", "properties": { "analyses": { "description": "Analyses due last calendar month (UTC) that started; one cancelled before it ran is not counted", "title": "Analyses", "type": "integer" }, "model_calls": { "description": "Model calls those analyses made", "title": "Model Calls", "type": "integer" } }, "required": [ "analyses", "model_calls" ], "title": "ImprovementUsageRead", "type": "object" }, "ImprovementsConfig": { "additionalProperties": false, "description": "The `improvements` capability: no configuration and no dependency; what runs is the\norganisation's settings row (`docs/architecture/improvements.md#the-capability`).", "properties": {}, "title": "ImprovementsConfig", "type": "object" }, "IncompleteDetails": { "additionalProperties": false, "description": "Why an incomplete response stopped.", "properties": { "reason": { "description": "why the response did not complete. `max_output_tokens` is upstream's own: the provider cut the model at its output limit -- the request's cap, the model's declared maximum Core lowered it to, or the model's own -- and the answer's last message is `incomplete`; ask again with a larger cap. `max_tool_rounds` is a fifth value beside upstream's `max_output_tokens`, `max_messages`, `content_filter` and `steered`: a tool-round ceiling is none of those, and saying `max_output_tokens` would tell a caller its token budget ran out when it did not. `task_deadline` is Core's too: the response is an agent task's run and the task's deadline passed before it finished. `usage_cap_exceeded` is Core's as well: the key's or the organisation's monthly cap was reached between two steps of the turn, so the model was not called again; what the turn produced until then is in `output` and is billed, and the next request is answered `429` until the cap is raised or the month turns. `cost_limit` is Core's too: this background run, the agent tasks it started and their runs spent the `cost_limit_eur` its request set; what was produced is kept and billed. `content_filter` is upstream's own: a blocking live check of the agent failed the answer, which is withheld; `GET /responses/{id}/checks` says which check", "enum": [ "max_tool_rounds", "max_output_tokens", "task_deadline", "usage_cap_exceeded", "cost_limit", "content_filter" ], "title": "Reason", "type": "string" } }, "required": [ "reason" ], "title": "IncompleteDetails", "type": "object" }, "IndexChunkRead": { "description": "One chunk a search hit or a `file_citation` names, read back by its id: the passage's text\nand where it came from (`docs/architecture/knowledge-and-memory.md#reading-a-cited-chunk`).", "properties": { "collection_id": { "description": "the collection that source belongs to", "title": "Collection Id", "type": "string" }, "id": { "description": "the chunk's id: a hit's `chunk_id`, a citation's `file_id`", "title": "Id", "type": "string" }, "image": { "anyOf": [ { "$ref": "#/components/schemas/HitImage" }, { "type": "null" } ], "description": "for a picture: its media type and where it is read, as on a search hit; null for a text chunk" }, "index_id": { "description": "the index the chunk belongs to", "title": "Index Id", "type": "string" }, "position": { "description": "the chunk's 0-based position among the chunks its source was cut into", "title": "Position", "type": "integer" }, "source_id": { "description": "the knowledge source the chunk was cut from", "title": "Source Id", "type": "string" }, "source_title": { "description": "the source's title: its file name for an upload", "title": "Source Title", "type": "string" }, "text": { "description": "the chunk's text, at most 32,768 Unicode code points; empty for a picture", "title": "Text", "type": "string" }, "truncated": { "description": "whether `text` was cut at that bound", "title": "Truncated", "type": "boolean" } }, "required": [ "id", "index_id", "source_id", "collection_id", "source_title", "position", "text", "truncated" ], "title": "IndexChunkRead", "type": "object" }, "IndexCollectionLink": { "additionalProperties": false, "description": "One collection an index -- or a knowledge graph -- selects, with an optional metadata filter\nscoping which of that collection's sources are drawn in (`app.knowledge.routing`).", "properties": { "collection_id": { "description": "Collection selected", "title": "Collection Id", "type": "string" }, "metadata_filter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Only sources whose metadata contains this are drawn in; null matches all", "title": "Metadata Filter" } }, "required": [ "collection_id" ], "title": "IndexCollectionLink", "type": "object" }, "IndexCreate": { "additionalProperties": false, "description": "Body of `POST /knowledge/indexes`.", "properties": { "collection_ids": { "description": "Collections this index selects (at most 16, checked with the duplicate check so both name the same unprefixed collection_ids field)", "items": { "$ref": "#/components/schemas/IndexCollectionLink" }, "title": "Collection Ids", "type": "array" }, "description": { "default": "", "description": "Human-readable description", "maxLength": 1024, "title": "Description", "type": "string" }, "embedding_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Catalogue embedding model id; null uses the deployment default", "title": "Embedding Model" }, "ingest_pipeline": { "anyOf": [ { "$ref": "#/components/schemas/PipelineRef" }, { "type": "null" } ], "description": "Ingest pipeline this index chunks new content with" }, "labels": { "default": {}, "description": "The organisation's classification of this index, as label -> value; what the rules over `knowledge_index` read", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the index, at most 16 KiB serialised: stored, returned and never read by Core; omitted or null stores {}", "title": "Metadata" }, "name": { "description": "Index name, unique per tenant", "maxLength": 64, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "IndexCreate", "type": "object" }, "IndexRead": { "description": "A knowledge index, as the API returns it. `reindex_required` is read on every answer:\nwhether `epoch` is ahead of the last full reindex that completed.", "properties": { "collection_ids": { "description": "Collections this index selects", "items": { "$ref": "#/components/schemas/IndexCollectionLink" }, "title": "Collection Ids", "type": "array" }, "created_at": { "description": "When this index was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created the index: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "description": { "description": "Human-readable description", "title": "Description", "type": "string" }, "embedding_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Catalogue embedding model id, when set", "title": "Embedding Model" }, "epoch": { "description": "The index's generation: bumped on a change of embedding model, ingest pipeline or selection (a collection added or removed, a link's metadata filter), and 1 from the start for an index created over sources already there", "title": "Epoch", "type": "integer" }, "id": { "description": "Knowledge index id", "title": "Id", "type": "string" }, "ingest_pipeline": { "anyOf": [ { "$ref": "#/components/schemas/PipelineRef" }, { "type": "null" } ], "description": "Ingest pipeline, when set" }, "labels": { "default": {}, "description": "The organisation's classification of this index, as label -> value", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "additionalProperties": true, "default": {}, "description": "The opaque document attached to this index; {} when none was set", "title": "Metadata", "type": "object" }, "name": { "description": "Index name, unique per tenant", "title": "Name", "type": "string" }, "object": { "const": "knowledge_index", "default": "knowledge_index", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/OriginRead" }, { "type": "null" } ], "description": "The subscription that installed this index, and the publication it came from; null for an index this organisation made itself. A copy indexes the subscriber's own collection copy, with the subscriber's own pipeline and model" }, "reindex_required": { "description": "True until a full reindex has completed at this epoch: sources the index newly draws in are not indexed before it, and chunks of an earlier generation are still there. A source the index no longer draws in stops answering searches at once", "title": "Reindex Required", "type": "boolean" }, "updated_at": { "description": "When this index was last updated", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "name", "description", "collection_ids", "embedding_model", "ingest_pipeline", "epoch", "reindex_required", "created_by", "created_at", "updated_at" ], "title": "IndexRead", "type": "object" }, "IndexRunRead": { "description": "One reindex of one index, as the API returns it.", "properties": { "created_at": { "description": "When this run was created", "format": "date-time", "title": "Created At", "type": "string" }, "epoch": { "description": "The index epoch this run ingests sources under", "title": "Epoch", "type": "integer" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Fixed code: 'all_sources_failed' or 'stalled' when failed, 'superseded' when cancelled because the target moved to a newer epoch under the run", "title": "Error Code" }, "finished_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this run finished", "title": "Finished At" }, "id": { "description": "Index run id", "title": "Id", "type": "string" }, "index_id": { "description": "Index this run reindexes", "title": "Index Id", "type": "string" }, "object": { "const": "knowledge_index_run", "default": "knowledge_index_run", "description": "The object's type", "title": "Object", "type": "string" }, "sources_done": { "description": "Sources that finished (ready or failed), or were deleted or re-routed away while the run was under way", "title": "Sources Done", "type": "integer" }, "sources_failed": { "description": "Sources that finished failed", "title": "Sources Failed", "type": "integer" }, "sources_total": { "description": "Sources this run covers", "title": "Sources Total", "type": "integer" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this run began executing", "title": "Started At" }, "status": { "description": "This run's current status", "enum": [ "queued", "running", "completed", "failed", "cancelled" ], "title": "Status", "type": "string" }, "trigger": { "description": "What started this run and in which mode: 'manual:full' for a rebuild, 'manual:failed' for a retry of the pairs whose last ingestion failed. A run written before modes existed reads 'manual', and means 'manual:full'", "title": "Trigger", "type": "string" } }, "required": [ "id", "index_id", "trigger", "status", "epoch", "sources_total", "sources_done", "sources_failed", "created_at" ], "title": "IndexRunRead", "type": "object" }, "IndexSourceCounts": { "description": "How many sources an index has drawn in, by ingestion status -- one number per\n`KnowledgeSourceIndex.status`, plus the total.", "properties": { "failed": { "description": "Sources whose ingestion failed", "title": "Failed", "type": "integer" }, "processing": { "description": "Sources being ingested right now", "title": "Processing", "type": "integer" }, "queued": { "description": "Sources waiting to be ingested", "title": "Queued", "type": "integer" }, "ready": { "description": "Sources ingested successfully", "title": "Ready", "type": "integer" }, "total": { "description": "Sources this index has drawn in, whatever their status", "title": "Total", "type": "integer" } }, "required": [ "total", "queued", "processing", "ready", "failed" ], "title": "IndexSourceCounts", "type": "object" }, "IndexStatsRead": { "description": "`GET /knowledge/indexes/{id}/stats`: what an index holds right now, cheap enough to poll.\n\nEvery number is an aggregate read, never a listing a caller has to fold up itself:\n`sources` counts the index's own `(source, index)` pairs by status, `chunks` sums the ready\nones' `chunk_count` -- a queued or failed pair's count is not content this index can answer\nwith -- and `tables`/`rows` count the tables of the sources it draws in, by the same routing\npredicate creating a source decides by (`app.knowledge.routing`).", "properties": { "active_run": { "anyOf": [ { "$ref": "#/components/schemas/ActiveRunRead" }, { "type": "null" } ], "description": "The reindex run queued or running for this index, when there is one" }, "chunks": { "description": "Chunks stored by this index's ready sources", "title": "Chunks", "type": "integer" }, "dimensions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Embedding width: the catalogue's for that model, else measured off one stored vector, else null when nothing has been embedded yet", "title": "Dimensions" }, "embedding_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The embedding model this index actually uses: its own, or the deployment default named when it chose none; null when this deployment configures neither", "title": "Embedding Model" }, "index_id": { "description": "The index these numbers describe", "title": "Index Id", "type": "string" }, "last_refresh_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The later of the last completed run's finish and the newest source's own ingestion; null until anything has been ingested", "title": "Last Refresh At" }, "object": { "const": "knowledge_index_stats", "default": "knowledge_index_stats", "description": "The object's type", "title": "Object", "type": "string" }, "rows": { "description": "Rows in those tables", "title": "Rows", "type": "integer" }, "sources": { "$ref": "#/components/schemas/IndexSourceCounts", "description": "Sources drawn in, by ingestion status" }, "tables": { "description": "Tables extracted from the sources this index draws in", "title": "Tables", "type": "integer" } }, "required": [ "index_id", "sources", "chunks", "tables", "rows", "embedding_model", "dimensions", "last_refresh_at", "active_run" ], "title": "IndexStatsRead", "type": "object" }, "IndexUpdate": { "additionalProperties": false, "description": "Body of `PATCH /knowledge/indexes/{index_id}`. A field left out of the request body is\nleft alone; `embedding_model`/`ingest_pipeline` are genuinely nullable targets (an explicit\n`null` resets to the deployment default / clears the pipeline), so this distinguishes \"field\nomitted\" from \"field sent as null\" through `model_fields_set`, not through the field's own\ndefault.", "properties": { "collection_ids": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IndexCollectionLink" }, "type": "array" }, { "type": "null" } ], "description": "Collections this index selects; replaces the current set (at most 16, checked with the duplicate check so both name the same unprefixed collection_ids field)", "title": "Collection Ids" }, "description": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "Human-readable description", "title": "Description" }, "embedding_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Catalogue embedding model id; null uses the deployment default", "title": "Embedding Model" }, "ingest_pipeline": { "anyOf": [ { "$ref": "#/components/schemas/PipelineRef" }, { "type": "null" } ], "description": "Ingest pipeline this index chunks new content with" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "new classification of this index, replacing whatever is stored; omitted leaves it alone, and an empty map clears it", "title": "Labels" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "new opaque document, replacing whatever is stored whole; omitted leaves it alone, and {} clears it", "title": "Metadata" }, "name": { "anyOf": [ { "maxLength": 64, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Index name, unique per tenant", "title": "Name" } }, "title": "IndexUpdate", "type": "object" }, "InjectedBlock": { "description": "One block the engine put into the context beside the thread's own items; for `skills`, the\nrelevance step's pick with no text, since the bodies are items.", "properties": { "dropped_by_budget": { "default": 0, "description": "for an injection by relevance, how many candidates did not fit its token budget or the turn's ceiling; a block naming none and dropping some sent nothing", "title": "Dropped By Budget", "type": "integer" }, "dropped_by_count": { "default": 0, "description": "for an injection by relevance, how many candidates a count left out", "title": "Dropped By Count", "type": "integer" }, "estimated_tokens": { "default": 0, "description": "for an injection or a working state, what it costs at four characters a token", "title": "Estimated Tokens", "type": "integer" }, "level": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "for a compaction summary, which tier it is: 0 for a summary of the thread's own items, 1 for a summary of level-0 summaries; null for any other kind of block", "title": "Level" }, "record_ids": { "description": "the rows the block was built from -- the memory records it renders, the summary row, the skills or tools it kept, the thread a working state was carried from; empty for a summary this very turn wrote, which has no row until the turn commits", "items": { "type": "string" }, "title": "Record Ids", "type": "array" }, "source": { "description": "memory, summary, skills, tools or working_state", "title": "Source", "type": "string" }, "trust": { "description": "the trust label the block was placed under", "title": "Trust", "type": "string" } }, "required": [ "source", "trust" ], "title": "InjectedBlock", "type": "object" }, "InjectionSettings": { "additionalProperties": false, "description": "How much of a store a turn's automatic injection may carry, beside the key's own\n`memory.injection` (`docs/architecture/knowledge-and-memory.md`, \"Automatic injection\").\nEvery field can only narrow what the key and the deployment already allow.", "properties": { "budget_tokens": { "anyOf": [ { "maximum": 8000.0, "minimum": 100.0, "type": "integer" }, { "type": "null" } ], "description": "token budget of the injected block for this store; it can only lower the key's `memory.injection.budget_tokens`, never raise it; null lowers nothing", "title": "Budget Tokens" }, "episodes_limit": { "default": 0, "description": "most past sessions (episodes) injected, in their own section after every other record: the turn's person's own, or the shared ones for a turn that names nobody, nearest the turn's query fused with how recently they happened, narrowed by the key's `memory.injection.metadata` and, when it names types, only if they include `episode`; 0, the default, injects none, and a turn with no query to rank by is handed none", "maximum": 5.0, "minimum": 0.0, "title": "Episodes Limit", "type": "integer" }, "person_limit": { "anyOf": [ { "maximum": 150.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "most of the turn's person's own records injected, besides commitments; null leaves the key's `memory.injection.limit` the only count", "title": "Person Limit" }, "rank": { "default": "confidence", "description": "how the person's and the organisation's records are ordered before the budget cuts them: `confidence` (effective confidence, then recalls), `relevance` (cosine of each record's embedding against the turn's query, which the turn embeds once for every source) or `blend` (reciprocal rank fusion of the two orders). Under `relevance` and `blend` a record without an embedding of the query's width ranks after those with one. Commitments are never ranked by relevance", "enum": [ "confidence", "relevance", "blend" ], "title": "Rank", "type": "string" }, "shared_budget_share": { "default": 0.4, "description": "largest share of the block's budget the organisation section may use, so a large shared store cannot crowd out the person's own records", "exclusiveMinimum": 0.0, "maximum": 1.0, "title": "Shared Budget Share", "type": "number" }, "shared_limit": { "anyOf": [ { "maximum": 150.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "most shared (organisation) records injected; null leaves the key's `memory.injection.limit` the only count", "title": "Shared Limit" } }, "title": "InjectionSettings", "type": "object" }, "InputAudioData": { "additionalProperties": false, "description": "A recording inline, in OpenAI's own `input_audio` shape.", "properties": { "data": { "description": "the recording, base64-encoded", "title": "Data", "type": "string" }, "format": { "description": "the format the caller says the recording is; accepted and checked against the bytes themselves, which decide", "enum": [ "wav", "mp3", "flac", "ogg", "oga", "m4a", "mp4", "mpeg", "mpga", "webm" ], "title": "Format", "type": "string" } }, "required": [ "data", "format" ], "title": "InputAudioData", "type": "object" }, "InputAudioPart": { "additionalProperties": false, "description": "A recording, inline or by reference to an uploaded file: transcribed by a catalogue audio\nmodel before the first model round, and read by the model as the user's own text\n(`docs/architecture/audio-transcription.md#audio-in-a-turn`).", "properties": { "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "id of a previously uploaded file holding the recording", "title": "File Id" }, "input_audio": { "anyOf": [ { "$ref": "#/components/schemas/InputAudioData" }, { "type": "null" } ], "description": "the recording inline, as base64 with its format" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Core extension: catalogue id of the audio model that transcribes this recording; left out, the operator's preferred audio model, else the first EU one, else the first the key's policy admits", "title": "Model" }, "type": { "const": "input_audio", "default": "input_audio", "description": "content part kind", "title": "Type", "type": "string" } }, "title": "InputAudioPart", "type": "object" }, "InputFileContent": { "additionalProperties": false, "description": "A file attachment, listed for display.", "properties": { "file_id": { "description": "id of the referenced file", "title": "File Id", "type": "string" }, "type": { "const": "input_file", "default": "input_file", "description": "output content kind", "title": "Type", "type": "string" } }, "required": [ "file_id" ], "title": "InputFileContent", "type": "object" }, "InputFilePart": { "additionalProperties": false, "description": "A file, by reference to an uploaded file id.", "properties": { "file_id": { "description": "id of a previously uploaded file", "title": "File Id", "type": "string" }, "type": { "const": "input_file", "default": "input_file", "description": "content part kind", "title": "Type", "type": "string" } }, "required": [ "file_id" ], "title": "InputFilePart", "type": "object" }, "InputImageContent": { "additionalProperties": false, "description": "An image attachment, listed for display.", "properties": { "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "id of the referenced image, when uploaded rather than inline", "title": "File Id" }, "type": { "const": "input_image", "default": "input_image", "description": "output content kind", "title": "Type", "type": "string" } }, "title": "InputImageContent", "type": "object" }, "InputImagePart": { "additionalProperties": false, "description": "An image, by reference to an uploaded file or inline as a base64 data URL.", "properties": { "detail": { "anyOf": [ { "enum": [ "auto", "low", "high" ], "type": "string" }, { "type": "null" } ], "description": "how closely the model should look at the image; sent to an OpenAI-family model with the image and ignored by every other, which has no word for it", "title": "Detail" }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "id of a previously uploaded file", "title": "File Id" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the image inline, as a base64-encoded data: URL", "title": "Image Url" }, "type": { "const": "input_image", "default": "input_image", "description": "content part kind", "title": "Type", "type": "string" } }, "title": "InputImagePart", "type": "object" }, "InputProperty": { "additionalProperties": false, "description": "One variable a template declares, as a JSON Schema property: its type, a description for\ncallers, the values it admits, and the fallback that fills it when no value is given.\n\nA closed subset of JSON Schema: a value is a scalar that renders as text, so there is no\nnesting, no `$ref` and no pattern, and checking one is a few comparisons (`value_problem`).", "properties": { "default": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ], "description": "Fixed text this placeholder renders when the caller gives no value: the author's own words, at the template's trust, and never read for placeholders. A value of the property's own type; null for none; at most one of `x-builtin` and `default`, and either makes the variable optional", "title": "Default" }, "description": { "default": "", "description": "what this variable holds, for callers", "maxLength": 500, "title": "Description", "type": "string" }, "enum": { "anyOf": [ { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ] }, "maxItems": 64, "minItems": 1, "type": "array" }, { "type": "null" } ], "description": "the only values this variable admits, each of its own type; null admits any value of the type, and a boolean takes none", "title": "Enum" }, "type": { "description": "the JSON type a value for this variable must have", "enum": [ "string", "number", "integer", "boolean" ], "title": "Type", "type": "string" }, "x-builtin": { "anyOf": [ { "maxLength": 80, "type": "string" }, { "type": "null" } ], "description": "A value Core fills this placeholder with when the caller gives none, by name: `date`: Today's date as YYYY-MM-DD, in the turn's timezone. `time`: The time of day as HH:MM, in the turn's timezone. `datetime`: The current instant in RFC 3339 with the turn's timezone offset. `weekday`: Today's day of the week in English, in the turn's timezone. `organisation_name`: The name of the organisation the turn is made for. `agent_name`: The name of the agent the request named; empty when it named none. `model`: The model the turn is made with, as the request or its agent names it. `subject_id`: The id of the person the turn is for; empty when it is for nobody. `subject_name`: The person's name attribute as the request asserts it; empty without one. `thread_id`: The id of the thread the turn is stored on; empty for a stateless turn. `run_id`: The id of the background run the turn is; empty for a synchronous turn. `subject.`: the value the request asserts for that attribute of the person, a list joined with ', '; empty when it asserts none. A value Core mints or holds to a closed vocabulary -- the time values, `model`, `agent_name`, the ids -- renders as the template's own text; free text somebody other than the template's author typed -- `organisation_name` and every value about the person -- renders as an untrusted segment, as a caller's value does. Null for none; at most one of `x-builtin` and `default`", "title": "X-Builtin" } }, "required": [ "type" ], "title": "InputProperty", "type": "object" }, "InputSchema": { "additionalProperties": false, "description": "Every variable a template declares, as one JSON Schema object: a property per\n`{{ name }}`, and the names a caller must give a value for in `required`.", "properties": { "additionalProperties": { "const": false, "default": false, "description": "always false: a value for an undeclared variable is refused", "title": "Additionalproperties", "type": "boolean" }, "properties": { "additionalProperties": { "$ref": "#/components/schemas/InputProperty" }, "description": "one property per `{{ name }}` placeholder, keyed by its name; every placeholder the template uses must be declared here, and vice versa", "maxProperties": 64, "title": "Properties", "type": "object" }, "required": { "description": "the variables a render call must give a value for; never one with a fallback", "items": { "type": "string" }, "maxItems": 64, "title": "Required", "type": "array" }, "type": { "const": "object", "default": "object", "description": "always `object`", "title": "Type", "type": "string" } }, "title": "InputSchema", "type": "object" }, "InputTextContent": { "additionalProperties": false, "description": "A non-assistant item's content, rendered as text for display.", "properties": { "text": { "description": "the item's text, rendered for display", "title": "Text", "type": "string" }, "type": { "const": "input_text", "default": "input_text", "description": "output content kind", "title": "Type", "type": "string" } }, "required": [ "text" ], "title": "InputTextContent", "type": "object" }, "InputTextPart": { "additionalProperties": false, "description": "Plain text supplied as one part of a message's content.", "properties": { "text": { "description": "the text, at most 1 MiB", "maxLength": 1048576, "title": "Text", "type": "string" }, "type": { "const": "input_text", "default": "input_text", "description": "content part kind", "title": "Type", "type": "string" } }, "required": [ "text" ], "title": "InputTextPart", "type": "object" }, "InputTokensDetails": { "additionalProperties": false, "description": "What the input tokens were made of, where the provider says.", "properties": { "cache_write_tokens": { "default": 0, "description": "the part of `input_tokens` written into the provider's prompt cache, which a provider charges more than an uncached token for; 0 where the provider reports no cache detail", "title": "Cache Write Tokens", "type": "integer" }, "cached_tokens": { "default": 0, "description": "the part of `input_tokens` the provider served from its prompt cache; 0 where the provider reports no cache detail", "title": "Cached Tokens", "type": "integer" } }, "title": "InputTokensDetails", "type": "object" }, "InstallReport": { "description": "What `POST /tenants/{tenant_id}/subscriptions/preview` answers: everything a person should\nknow before installing a bundle, and nothing written.\n\nThe one section that is a refusal is `capabilities.missing` -- the subscribe route refuses\nexactly that, and nothing else here. `models`, `egress`, `keys` and `policy` are advice, and\n`parameters.missing` and `clients.unconfigured` are the state a subscription would be\n*written* in rather than refused (`needs_configuration`).\n\n**A preview reaches as far as the listing does, so it withholds what the listing withholds.**\nThis route takes the same reach as `GET .../available-publications/{id}`, which for a\n`catalogue` publication is every organisation of the deployment -- and `models`, `egress`,\n`tools` and `policy` are all read *out of the definitions*: which models a bundle runs on,\nwhich hosts its connectors dial, which tools it renames and which policy its publisher\nrecommends. So when the detail would withhold the definitions, so does this\n(`definitions_withheld`, `app.sharing.available.withholds_definitions`). What still answers is\nwhat belongs to the *subscriber* rather than to the bundle: the capabilities its own ceiling\nlacks, the parameters it has not filled in, the names its own rows already hold, and the\ndeployment applications it has not configured -- a name is part of what the bundle requires,\nlike a capability, and withholding never hides what installing requires.", "properties": { "capabilities": { "$ref": "#/components/schemas/CapabilityReport", "description": "What the bundle needs switched on" }, "clients": { "$ref": "#/components/schemas/ClientReport", "description": "Which deployment OAuth applications the bundle names that this deployment has not configured" }, "definitions_withheld": { "default": false, "description": "Whether this report withholds what the bundle's definitions say -- the version is sealed, or its terms ask for an entitlement this organisation does not hold. `models`, `egress`, `tools` and `policy` are then empty, and the sections that are this organisation's own facts -- capabilities, missing parameters, name collisions, unconfigured applications -- still answer", "title": "Definitions Withheld", "type": "boolean" }, "egress": { "description": "Every host the bundle's connectors and servers would reach, their token endpoints included, once the parameters in this body are filled in, each with whether this organisation's allowed hosts permit it and whether the deployment blocks it; a parameter with no value contributes no host. Installing adds no host to the organisation's allowed hosts: a host that is not allowed stays refused until an administrator adds it", "items": { "$ref": "#/components/schemas/HostAccess" }, "title": "Egress", "type": "array" }, "keys": { "description": "Per key of this organisation, what its policy would refuse; a key that would refuse nothing is left out", "items": { "$ref": "#/components/schemas/KeyRefusal" }, "title": "Keys", "type": "array" }, "members": { "$ref": "#/components/schemas/MemberReport", "description": "Which conditional members this configuration leaves out" }, "models": { "$ref": "#/components/schemas/ModelReport", "description": "Which models it names, and which are unavailable" }, "names": { "$ref": "#/components/schemas/NameReport", "description": "Which installed names are already taken" }, "object": { "const": "install.report", "default": "install.report", "description": "The object's type", "title": "Object", "type": "string" }, "packages": { "description": "The packages the bundle's scripts bring because only its publisher approved them: installing accepts them for those copied scripts alone and adds none to this organisation's own list. Answered whatever the definitions withhold, as the capabilities are, because installing is agreeing to them", "items": { "$ref": "#/components/schemas/BroughtPackage" }, "title": "Packages", "type": "array" }, "parameters": { "$ref": "#/components/schemas/ParameterReport", "description": "Which parameters still have no value" }, "policy": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The policy document the publisher recommends, reported back verbatim and never applied: a console offers it as 'create a key with this policy'. Null while the definitions are withheld", "title": "Policy" }, "publication_id": { "description": "The publication this report is about", "title": "Publication Id", "type": "string" }, "tools": { "$ref": "#/components/schemas/ToolReport", "description": "Which tools the bundle's aliases point at that this organisation has not got" }, "version": { "description": "The publication version it would install", "title": "Version", "type": "integer" } }, "required": [ "publication_id", "version", "capabilities", "models", "parameters", "names" ], "title": "InstallReport", "type": "object" }, "InstallValue": { "additionalProperties": false, "description": "One `$name`'s value and what it is: the shape a bundle parameter has, so exporting one is\na copy (`app.sharing.parameterise.adopt_install_values`).", "properties": { "allowed": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 64, "minItems": 1, "type": "array" }, { "type": "null" } ], "description": "the values an enum admits, `value` among them; required for enum and refused elsewhere", "title": "Allowed" }, "description": { "default": "", "description": "what this value is for, shown to whoever sets it", "maxLength": 1024, "title": "Description", "type": "string" }, "type": { "description": "string, number or enum", "enum": [ "string", "number", "enum" ], "title": "Type", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ], "description": "the value: a finite number for `number`, text for `string` and `enum`", "title": "Value" } }, "required": [ "type", "value" ], "title": "InstallValue", "type": "object" }, "InstructorEntry": { "additionalProperties": false, "description": "One entry of an account's instruct list: a key of the organisation, and the person its\nrequests must name for the entry to count, when it names one\n(`docs/architecture/service-accounts.md#who-may-instruct`).", "properties": { "key_id": { "description": "A key of this organisation that may instruct", "maxLength": 64, "minLength": 1, "title": "Key Id", "type": "string" }, "subject_id": { "anyOf": [ { "pattern": "^[A-Za-z0-9._:@-]{1,128}$", "type": "string" }, { "type": "null" } ], "description": "When set, only that key's requests naming this person may instruct; never an account's id", "title": "Subject Id" } }, "required": [ "key_id" ], "title": "InstructorEntry", "type": "object" }, "InstructorSummary": { "description": "One instructor's share of an account's activity over the window: who handed the work over,\nand what it came to.", "properties": { "cost_eur": { "description": "What those turns and their tools cost, in euro, at the prices in force when each usage row was recorded", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Cost Eur", "type": "string" }, "instructed_by_key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The key that handed the work over; null with a null subject for work nobody handed over (a schedule, a trigger, management)", "title": "Instructed By Key Id" }, "instructed_by_subject_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the instructing request named, when it named one", "title": "Instructed By Subject Id" }, "last_activity_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The latest usage or audit row counted here; null for none", "title": "Last Activity At" }, "mails_sent": { "description": "Mails the account's own mailbox handed to its server", "title": "Mails Sent", "type": "integer" }, "refusals": { "description": "Denied policy decisions recorded for the account", "title": "Refusals", "type": "integer" }, "turns": { "description": "Responses the account ran for this instructor", "title": "Turns", "type": "integer" }, "unpriced": { "description": "Usage rows no price covered, counted as zero in `cost_eur`", "title": "Unpriced", "type": "integer" } }, "required": [ "instructed_by_key_id", "instructed_by_subject_id", "turns", "cost_eur", "unpriced", "refusals", "mails_sent", "last_activity_at" ], "title": "InstructorSummary", "type": "object" }, "Interpretation": { "description": "Core's own reading of the call it is attached to.", "properties": { "agent": { "anyOf": [ { "$ref": "#/components/schemas/AgentNote" }, { "type": "null" } ], "description": "the stored agent this call's turn was built on and the request fields it ran on the agent's value of; null for a turn that named no agent, and for one made before this was recorded" }, "answer": { "anyOf": [ { "$ref": "#/components/schemas/Answer" }, { "type": "null" } ], "description": "Core's reading of what the model answered on this call: null for a call that did not end `ok` -- except one that failed `invalid_structured_output`, which keeps the answer that did not match -- and for a kind that produces no message" }, "blocks": { "description": "the memory, summary and retrieval blocks injected", "items": { "$ref": "#/components/schemas/InjectedBlock" }, "title": "Blocks", "type": "array" }, "call_depth": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how deep the turn is in a call chain", "title": "Call Depth" }, "compaction": { "anyOf": [ { "$ref": "#/components/schemas/CompactionNote" }, { "type": "null" } ], "description": "how much of the thread this call was handed and whose configuration decided it; null for a call on no thread, and for one made before this was recorded" }, "elements": { "description": "every context element sent, in order", "items": { "$ref": "#/components/schemas/ContextElement" }, "title": "Elements", "type": "array" }, "pseudonyms": { "description": "every placeholder standing in those elements", "items": { "$ref": "#/components/schemas/PseudonymSpan" }, "title": "Pseudonyms", "type": "array" }, "recovery": { "anyOf": [ { "$ref": "#/components/schemas/RecoveryNote" }, { "type": "null" } ], "description": "the attempt and check of a recovery call; null on any other" }, "routing": { "anyOf": [ { "$ref": "#/components/schemas/Routing" }, { "type": "null" } ], "description": "the routing chain behind this call; null when none was read" }, "tool_variables_ignored": { "description": "the names in the request's `tool_variables` no tool of this turn declares, which were ignored; never their values", "items": { "type": "string" }, "title": "Tool Variables Ignored", "type": "array" }, "tools": { "description": "every tool this call could have offered, offered and withheld alike", "items": { "$ref": "#/components/schemas/OfferedTool" }, "title": "Tools", "type": "array" } }, "title": "Interpretation", "type": "object" }, "ItemList": { "additionalProperties": false, "description": "The items a `POST /threads/{thread_id}/items` call appended, in order.", "properties": { "items": { "description": "the appended items", "items": { "discriminator": { "mapping": { "custom_tool_call": "#/components/schemas/ThreadCustomToolCall", "function_call": "#/components/schemas/ThreadFunctionCall", "function_call_output": "#/components/schemas/ToolResultRead", "message": "#/components/schemas/ThreadMessage", "reasoning": "#/components/schemas/ThreadReasoning" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ThreadMessage" }, { "$ref": "#/components/schemas/ThreadReasoning" }, { "$ref": "#/components/schemas/ThreadFunctionCall" }, { "$ref": "#/components/schemas/ThreadCustomToolCall" }, { "$ref": "#/components/schemas/ToolResultRead" } ] }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "ItemList", "type": "object" }, "ItemMetadataRead": { "description": "One person's document on an item.", "properties": { "created_at": { "description": "when this person first wrote a document here", "format": "date-time", "title": "Created At", "type": "string" }, "item_id": { "description": "the item it is about", "title": "Item Id", "type": "string" }, "metadata": { "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "description": "the document, as written", "title": "Metadata", "type": "object" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "whose document it is; null for the organisation's own, or, for a subject token, for anyone else's", "title": "Subject" }, "thread_id": { "description": "the thread the item sits in", "title": "Thread Id", "type": "string" }, "updated_at": { "description": "when this person last replaced it", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "item_id", "thread_id", "subject", "metadata", "created_at", "updated_at" ], "title": "ItemMetadataRead", "type": "object" }, "ItemMetadataWrite": { "additionalProperties": false, "description": "The whole of one person's document on an item, replacing what she wrote before. Not\n`Update`, because a `PUT` replaces the document whole rather than patching it.", "properties": { "metadata": { "description": "up to 16 keys, each holding a string of at most 512 characters, a number or a boolean; Core never reads it", "maxProperties": 16, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "maxLength": 512, "type": "string" } ] } }, "title": "Metadata", "type": "object" } }, "required": [ "metadata" ], "title": "ItemMetadataWrite", "type": "object" }, "JsonFormatIn": { "additionalProperties": false, "description": "A JSON Schema the model's output text must satisfy.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a name for the schema", "title": "Name" }, "schema": { "additionalProperties": true, "description": "the schema the output satisfies", "title": "Schema", "type": "object" }, "type": { "const": "json_schema", "default": "json_schema", "description": "output format kind", "title": "Type", "type": "string" } }, "required": [ "schema" ], "title": "JsonFormatIn", "type": "object" }, "JsonSchemaAssistRead": { "description": "What the JSON Schema helper wrote. Nothing is stored: the caller decides where it goes.", "properties": { "explanation": { "description": "What the schema requires, in a few sentences of the model's own, for the person deciding whether to use it", "title": "Explanation", "type": "string" }, "json_schema": { "additionalProperties": true, "description": "The schema the helper wrote: valid Draft 2020-12, referring to nothing outside itself, with an object at the root when a target was named", "title": "Json Schema", "type": "object" }, "model": { "description": "The catalogue chat model that wrote it", "title": "Model", "type": "string" }, "object": { "const": "assist.json_schema", "default": "assist.json_schema", "description": "The object's type", "title": "Object", "type": "string" } }, "required": [ "json_schema", "explanation", "model" ], "title": "JsonSchemaAssistRead", "type": "object" }, "JsonSchemaAssistRequest": { "additionalProperties": false, "description": "Body of `POST /assist/json-schema` and its management twin.", "properties": { "current_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "A schema to start from and change as the description asks; omit it to write one from nothing. At most as large as a datastore's schema may be", "title": "Current Schema" }, "description": { "description": "What the data looks like, in plain language -- the fields, their kinds, which are required. Sent to the organisation's helper model as data, never as an instruction", "maxLength": 4000, "minLength": 1, "title": "Description", "type": "string" }, "target": { "anyOf": [ { "enum": [ "datastore", "tool_parameters", "structured_output" ], "type": "string" }, { "type": "null" } ], "description": "Where the schema will be used, so the answer fits it: 'datastore' for a datastore's records, 'tool_parameters' for an API connector's tool arguments, 'structured_output' for a turn's structured answer. Each takes an object at the root; omit it for a schema used anywhere else", "title": "Target" } }, "required": [ "description" ], "title": "JsonSchemaAssistRequest", "type": "object" }, "JsonSchemaFormatParam": { "additionalProperties": false, "description": "The model's output text must be JSON conforming to `schema`.\n\n`populate_by_name=True`: a request still spells this field `schema` on the wire (the alias),\nbut a background run (`app.responses.stored_turn`) must also re-validate its own stored\n`options.text` -- written by `model_dump(mode=\"json\")`, which serialises by field name\n(`json_schema`), not the alias -- when it resumes, so the model this field must accept both\nspellings.", "properties": { "name": { "description": "a name for the schema", "title": "Name", "type": "string" }, "schema": { "additionalProperties": true, "description": "the JSON Schema the output text must satisfy", "title": "Schema", "type": "object" }, "strict": { "default": true, "description": "require exact schema conformance", "title": "Strict", "type": "boolean" }, "type": { "const": "json_schema", "default": "json_schema", "description": "output format kind", "title": "Type", "type": "string" } }, "required": [ "name", "schema" ], "title": "JsonSchemaFormatParam", "type": "object" }, "JsonValue": {}, "KeptSecret": { "additionalProperties": false, "description": "`{\"$keep\": true}`: keep the secret the connector's latest version holds under this name.", "properties": { "$keep": { "const": true, "description": "always true", "title": "$Keep", "type": "boolean" } }, "required": [ "$keep" ], "title": "KeptSecret", "type": "object" }, "KeyCallbackSecret": { "description": "A key's callback secret at the one moment it exists outside Core: the answer of\n`POST /key/callback-secret` and of its twins for a named key. Not a `KeyRead` with one more\nfield: it names the key and carries the secret, and a read of the key says only that one is\nset (`docs/architecture/runs.md#a-callback-is-a-reply-arriving-late-never-an-initiation`).", "properties": { "key_id": { "description": "The API key whose run callbacks are signed with this secret", "title": "Key Id", "type": "string" }, "object": { "const": "api_key.callback_secret", "default": "api_key.callback_secret", "description": "The object's type", "title": "Object", "type": "string" }, "secret": { "description": "The secret every run callback of this key is signed with (`Artific-Signature`), replacing any earlier one; store it now, it is not shown again", "title": "Secret", "type": "string" } }, "required": [ "key_id", "secret" ], "title": "KeyCallbackSecret", "type": "object" }, "KeyCreate": { "additionalProperties": false, "description": "Body of `POST /tenants/{tenant_id}/keys`.", "properties": { "capabilities": { "additionalProperties": false, "description": "Capability configs this key enables, by capability name", "properties": { "agents": { "$ref": "#/components/schemas/AgentsConfig" }, "artifacts": { "$ref": "#/components/schemas/ArtifactsConfig" }, "assist": { "$ref": "#/components/schemas/AssistConfig" }, "compaction": { "$ref": "#/components/schemas/CompactionConfig" }, "computer": { "$ref": "#/components/schemas/ComputerConfig" }, "datastores": { "$ref": "#/components/schemas/DatastoresConfig" }, "evaluations": { "$ref": "#/components/schemas/EvaluationsConfig" }, "files": { "$ref": "#/components/schemas/FilesConfig" }, "improvements": { "$ref": "#/components/schemas/ImprovementsConfig" }, "knowledge": { "$ref": "#/components/schemas/KnowledgeConfig" }, "management": { "$ref": "#/components/schemas/ManagementConfig" }, "memory": { "$ref": "#/components/schemas/MemoryConfig" }, "product_events": { "$ref": "#/components/schemas/ProductEventsConfig" }, "prompts": { "$ref": "#/components/schemas/PromptsConfig" }, "pseudonymisation": { "$ref": "#/components/schemas/PseudonymisationConfig" }, "runs": { "$ref": "#/components/schemas/RunsConfig" }, "schedules": { "$ref": "#/components/schemas/SchedulesConfig" }, "skills": { "$ref": "#/components/schemas/SkillsConfig" }, "subjects": { "$ref": "#/components/schemas/SubjectsConfig" }, "tasks": { "$ref": "#/components/schemas/TasksConfig" }, "threads": { "$ref": "#/components/schemas/ThreadsConfig" }, "tooling": { "$ref": "#/components/schemas/ToolingConfig" }, "trust_envelope": { "$ref": "#/components/schemas/TrustEnvelopeConfig" }, "workflows": { "$ref": "#/components/schemas/WorkflowsConfig" } }, "title": "Capabilities", "type": "object" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this key stops authenticating anything; null, or omitted, is a key that never expires. Must be in the future", "title": "Expires At" }, "fallback_routing_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this key falls over to another model at all; false is the opt-out, whatever the key or its organisation names. Leave it out for the default, which is true", "title": "Fallback Routing Enabled" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the key, at most 16 KiB serialised: stored, returned and never read by Core; omitted or null stores {}", "title": "Metadata" }, "monthly_cost_cap_eur": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Ceiling on what this key may spend in a calendar month (UTC), in euro; null is no cap and 0 is a real one. Counts every priced kind and is weighed before the organisation's own cap; never checked against it", "title": "Monthly Cost Cap Eur" }, "monthly_cost_cap_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the key's monthly cap stops binding: only the end of the current cap period, the first instant of next month at 00:00:00 UTC, so a cap for this month only lifts by itself as the month turns; any other instant is 422. Null makes the cap standing. A cap sent without this field keeps an end still to come, lifting the cap clears it, and sending it with no binding cap to end is 422", "title": "Monthly Cost Cap Until" }, "name": { "description": "Human-readable key name", "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" }, "policy": { "$ref": "#/components/schemas/PolicyDocument", "description": "The policy document this key calls under: its rules and settings. Omitted, the default rules are stored" }, "reasoning_summaries_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this key's turns on a thinking model ask for the model's reasoning back in readable form by default; null, or omitted, follows the organisation's reasoning_summaries_enabled. A request's or an agent's own reasoning.summary always wins", "title": "Reasoning Summaries Enabled" }, "routing_config_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "This key's own routing configuration, which must be one of its tenant's; null to follow the organisation's default", "title": "Routing Config Id" }, "secret": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "description": "A secret the caller generated, in the exact shape Core issues: 'ack_' and 43 URL-safe base64 characters (32 random bytes). Omitted, Core generates one. Either way it is answered once and only its SHA-256 is kept; a secret some key already has is refused", "pattern": "^ack_[A-Za-z0-9_-]{43}$", "title": "Secret" } }, "required": [ "name" ], "title": "KeyCreate", "type": "object" }, "KeyIssued": { "description": "An API key at the one moment its secret exists outside Core: the response of\n`POST /tenants/{tenant_id}/keys` and of `POST /tenants/{tenant_id}/keys/{key_id}/rotate`,\nwhether Core generated the secret or the caller supplied it.\n\nEvery other route answers `KeyRead`, which has no `secret` field to fill in -- Core keeps\nonly the secret's SHA-256, so there is nowhere to read it back from\n(`docs/architecture/identity.md`).", "properties": { "callback_secret_set": { "description": "Whether this key's run callbacks are signed (`Artific-Signature`): true once a callback secret was created for it. The secret itself is never returned here", "title": "Callback Secret Set", "type": "boolean" }, "capabilities": { "additionalProperties": { "additionalProperties": true, "type": "object" }, "description": "Capability configs this key enables, as registered", "title": "Capabilities", "type": "object" }, "created_at": { "description": "When the key was registered", "format": "date-time", "title": "Created At", "type": "string" }, "disabled_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this key was disabled; null for a key in service. A disabled key authenticates nothing, nor does any subject token it minted, until it is enabled again", "title": "Disabled At" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this key stops authenticating anything; null for a key that never expires", "title": "Expires At" }, "fallback_routing_enabled": { "description": "Whether this key falls over to another model at all", "title": "Fallback Routing Enabled", "type": "boolean" }, "id": { "description": "API key id", "title": "Id", "type": "string" }, "metadata": { "additionalProperties": true, "description": "The opaque document attached to this key; {} when none was set", "title": "Metadata", "type": "object" }, "monthly_cost_cap_eur": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Ceiling on what this key may spend in a calendar month (UTC), in euro; null when it has none", "title": "Monthly Cost Cap Eur" }, "monthly_cost_cap_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the key's monthly cap stops binding -- the end of the cap period it was set in -- or null for a standing cap. A cap past it binds nobody and is still shown here", "title": "Monthly Cost Cap Until" }, "name": { "description": "Human-readable key name", "title": "Name", "type": "string" }, "object": { "const": "api_key", "default": "api_key", "description": "The object's type", "title": "Object", "type": "string" }, "policy": { "$ref": "#/components/schemas/PolicyDocument", "description": "The policy document this key calls under: its rules and settings" }, "policy_version": { "description": "The version of this key's policy document: opaque, and different after every write of the document. Send it back in `If-Match` on an update to have the update refused when the document changed in between", "readOnly": true, "title": "Policy Version", "type": "string" }, "reasoning_summaries_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this key's turns on a thinking model ask for the model's reasoning back in readable form by default; null when it follows its organisation's setting", "title": "Reasoning Summaries Enabled" }, "routing_config_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "This key's own routing configuration; null when it follows its organisation's default", "title": "Routing Config Id" }, "secret": { "description": "The key's secret, returned exactly once; Core keeps only its SHA-256 hash and cannot show this value again", "title": "Secret", "type": "string" }, "secret_prefix": { "description": "The first twelve characters of this key's secret, so it can be recognised in a list; never a credential, and never enough to call with", "title": "Secret Prefix", "type": "string" }, "service_account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The service account that owns this key, which is then managed through the account's routes; null for a key no account owns", "title": "Service Account Id" }, "tenant_id": { "description": "Owning tenant id", "title": "Tenant Id", "type": "string" }, "updated_at": { "description": "When the key was last updated", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "secret_prefix", "name", "capabilities", "policy", "monthly_cost_cap_eur", "monthly_cost_cap_until", "routing_config_id", "fallback_routing_enabled", "reasoning_summaries_enabled", "expires_at", "disabled_at", "service_account_id", "callback_secret_set", "metadata", "created_at", "updated_at", "secret", "policy_version" ], "title": "KeyIssued", "type": "object" }, "KeyLink": { "description": "The key a suite's runs act as, as a reader wants it: the id to follow and the name to show.\n\nResolved from the control plane when the suite is read, and `None` on `EvaluationRead` when\nthe suite names a key that has since been deleted -- the id stays on the row, but there is no\nlonger a key to name (`app.evaluations.models`).", "properties": { "id": { "description": "API key id", "title": "Id", "type": "string" }, "name": { "description": "The key's name", "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "KeyLink", "type": "object" }, "KeyRead": { "description": "An API key, as the operator API returns it.", "properties": { "callback_secret_set": { "description": "Whether this key's run callbacks are signed (`Artific-Signature`): true once a callback secret was created for it. The secret itself is never returned here", "title": "Callback Secret Set", "type": "boolean" }, "capabilities": { "additionalProperties": false, "description": "Capability configs this key enables, as registered", "properties": { "agents": { "$ref": "#/components/schemas/AgentsConfig" }, "artifacts": { "$ref": "#/components/schemas/ArtifactsConfig" }, "assist": { "$ref": "#/components/schemas/AssistConfig" }, "compaction": { "$ref": "#/components/schemas/CompactionConfig" }, "computer": { "$ref": "#/components/schemas/ComputerConfig" }, "datastores": { "$ref": "#/components/schemas/DatastoresConfig" }, "evaluations": { "$ref": "#/components/schemas/EvaluationsConfig" }, "files": { "$ref": "#/components/schemas/FilesConfig" }, "improvements": { "$ref": "#/components/schemas/ImprovementsConfig" }, "knowledge": { "$ref": "#/components/schemas/KnowledgeConfig" }, "management": { "$ref": "#/components/schemas/ManagementConfig" }, "memory": { "$ref": "#/components/schemas/MemoryConfig" }, "product_events": { "$ref": "#/components/schemas/ProductEventsConfig" }, "prompts": { "$ref": "#/components/schemas/PromptsConfig" }, "pseudonymisation": { "$ref": "#/components/schemas/PseudonymisationConfig" }, "runs": { "$ref": "#/components/schemas/RunsConfig" }, "schedules": { "$ref": "#/components/schemas/SchedulesConfig" }, "skills": { "$ref": "#/components/schemas/SkillsConfig" }, "subjects": { "$ref": "#/components/schemas/SubjectsConfig" }, "tasks": { "$ref": "#/components/schemas/TasksConfig" }, "threads": { "$ref": "#/components/schemas/ThreadsConfig" }, "tooling": { "$ref": "#/components/schemas/ToolingConfig" }, "trust_envelope": { "$ref": "#/components/schemas/TrustEnvelopeConfig" }, "workflows": { "$ref": "#/components/schemas/WorkflowsConfig" } }, "title": "Capabilities", "type": "object" }, "created_at": { "description": "When the key was registered", "format": "date-time", "title": "Created At", "type": "string" }, "disabled_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this key was disabled; null for a key in service. A disabled key authenticates nothing, nor does any subject token it minted, until it is enabled again", "title": "Disabled At" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this key stops authenticating anything; null for a key that never expires", "title": "Expires At" }, "fallback_routing_enabled": { "description": "Whether this key falls over to another model at all", "title": "Fallback Routing Enabled", "type": "boolean" }, "id": { "description": "API key id", "title": "Id", "type": "string" }, "metadata": { "additionalProperties": true, "description": "The opaque document attached to this key; {} when none was set", "title": "Metadata", "type": "object" }, "monthly_cost_cap_eur": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Ceiling on what this key may spend in a calendar month (UTC), in euro; null when it has none", "title": "Monthly Cost Cap Eur" }, "monthly_cost_cap_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the key's monthly cap stops binding -- the end of the cap period it was set in -- or null for a standing cap. A cap past it binds nobody and is still shown here", "title": "Monthly Cost Cap Until" }, "name": { "description": "Human-readable key name", "title": "Name", "type": "string" }, "object": { "const": "api_key", "default": "api_key", "description": "The object's type", "title": "Object", "type": "string" }, "policy": { "$ref": "#/components/schemas/PolicyDocument", "description": "The policy document this key calls under: its rules and settings" }, "policy_version": { "description": "The version of this key's policy document: opaque, and different after every write of the document. Send it back in `If-Match` on an update to have the update refused when the document changed in between", "readOnly": true, "title": "Policy Version", "type": "string" }, "reasoning_summaries_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this key's turns on a thinking model ask for the model's reasoning back in readable form by default; null when it follows its organisation's setting", "title": "Reasoning Summaries Enabled" }, "routing_config_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "This key's own routing configuration; null when it follows its organisation's default", "title": "Routing Config Id" }, "secret_prefix": { "description": "The first twelve characters of this key's secret, so it can be recognised in a list; never a credential, and never enough to call with", "title": "Secret Prefix", "type": "string" }, "service_account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The service account that owns this key, which is then managed through the account's routes; null for a key no account owns", "title": "Service Account Id" }, "tenant_id": { "description": "Owning tenant id", "title": "Tenant Id", "type": "string" }, "updated_at": { "description": "When the key was last updated", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "secret_prefix", "name", "capabilities", "policy", "monthly_cost_cap_eur", "monthly_cost_cap_until", "routing_config_id", "fallback_routing_enabled", "reasoning_summaries_enabled", "expires_at", "disabled_at", "service_account_id", "callback_secret_set", "metadata", "created_at", "updated_at", "policy_version" ], "title": "KeyRead", "type": "object" }, "KeyRefusal": { "additionalProperties": false, "description": "What one of this organisation's keys would refuse of what the bundle introduces.\n\nAdvice and never a refusal: a key's policy is the organisation's own to change, and a\nsubscription installs rows rather than using them. What the report buys is the question a\nconsole can ask before the install rather than after the first failed turn\n(`docs/architecture/tenancy.md` \"Which resources a key reaches\").", "properties": { "egress": { "description": "Hosts the bundle's connectors and servers reach, token endpoints included, that a call under this key would be refused: the deployment blocks the host, the organisation has not allowed it, or this key's own rules do not", "items": { "type": "string" }, "title": "Egress", "type": "array" }, "key_id": { "description": "The key whose policy was weighed", "title": "Key Id", "type": "string" }, "resources": { "description": "`:` of the copies this key's rules would not reach", "items": { "type": "string" }, "title": "Resources", "type": "array" }, "tools": { "description": "Qualified tool names the bundle introduces that this key's policy refuses", "items": { "type": "string" }, "title": "Tools", "type": "array" } }, "required": [ "key_id" ], "title": "KeyRefusal", "type": "object" }, "KeyRotate": { "additionalProperties": false, "description": "Body of `POST /tenants/{tenant_id}/keys/{key_id}/rotate` and its key-facing twins; optional,\nand no body at all is the same as `{}`: Core generates the new secret.", "properties": { "secret": { "anyOf": [ { "format": "password", "type": "string", "writeOnly": true }, { "type": "null" } ], "description": "A secret the caller generated, in the exact shape Core issues: 'ack_' and 43 URL-safe base64 characters (32 random bytes). Omitted, Core generates one. Either way it is answered once and only its SHA-256 is kept; a secret some key already has is refused", "pattern": "^ack_[A-Za-z0-9_-]{43}$", "title": "Secret" } }, "title": "KeyRotate", "type": "object" }, "KeyUpdate": { "additionalProperties": false, "description": "Body of `PATCH /tenants/{tenant_id}/keys/{key_id}`; every field is optional and left\nalone when absent.", "properties": { "capabilities": { "anyOf": [ { "additionalProperties": false, "properties": { "agents": { "$ref": "#/components/schemas/AgentsConfig" }, "artifacts": { "$ref": "#/components/schemas/ArtifactsConfig" }, "assist": { "$ref": "#/components/schemas/AssistConfig" }, "compaction": { "$ref": "#/components/schemas/CompactionConfig" }, "computer": { "$ref": "#/components/schemas/ComputerConfig" }, "datastores": { "$ref": "#/components/schemas/DatastoresConfig" }, "evaluations": { "$ref": "#/components/schemas/EvaluationsConfig" }, "files": { "$ref": "#/components/schemas/FilesConfig" }, "improvements": { "$ref": "#/components/schemas/ImprovementsConfig" }, "knowledge": { "$ref": "#/components/schemas/KnowledgeConfig" }, "management": { "$ref": "#/components/schemas/ManagementConfig" }, "memory": { "$ref": "#/components/schemas/MemoryConfig" }, "product_events": { "$ref": "#/components/schemas/ProductEventsConfig" }, "prompts": { "$ref": "#/components/schemas/PromptsConfig" }, "pseudonymisation": { "$ref": "#/components/schemas/PseudonymisationConfig" }, "runs": { "$ref": "#/components/schemas/RunsConfig" }, "schedules": { "$ref": "#/components/schemas/SchedulesConfig" }, "skills": { "$ref": "#/components/schemas/SkillsConfig" }, "subjects": { "$ref": "#/components/schemas/SubjectsConfig" }, "tasks": { "$ref": "#/components/schemas/TasksConfig" }, "threads": { "$ref": "#/components/schemas/ThreadsConfig" }, "tooling": { "$ref": "#/components/schemas/ToolingConfig" }, "trust_envelope": { "$ref": "#/components/schemas/TrustEnvelopeConfig" }, "workflows": { "$ref": "#/components/schemas/WorkflowsConfig" } }, "type": "object" }, { "type": "null" } ], "description": "Capability configs this key enables, by capability name", "title": "Capabilities" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this key stops authenticating anything; send null to clear an expiry the key has, leave the field out to keep what it has. Must be in the future when set", "title": "Expires At" }, "fallback_routing_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this key falls over to another model at all", "title": "Fallback Routing Enabled" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "new opaque document, replacing whatever is stored whole; omitted leaves it alone, and {} clears it", "title": "Metadata" }, "monthly_cost_cap_eur": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Ceiling on what this key may spend in a calendar month (UTC), in euro; send null to lift it, and omit the field to leave it as it is", "title": "Monthly Cost Cap Eur" }, "monthly_cost_cap_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the key's monthly cap stops binding: only the end of the current cap period, the first instant of next month at 00:00:00 UTC, so a cap for this month only lifts by itself as the month turns; any other instant is 422. Null makes the cap standing. A cap sent without this field keeps an end still to come, lifting the cap clears it, and sending it with no binding cap to end is 422", "title": "Monthly Cost Cap Until" }, "name": { "anyOf": [ { "maxLength": 200, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Human-readable key name", "title": "Name" }, "policy": { "anyOf": [ { "$ref": "#/components/schemas/PolicyDocument" }, { "type": "null" } ], "description": "The policy document this key calls under; sent, it replaces the stored document whole" }, "reasoning_summaries_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this key's turns on a thinking model ask for the model's reasoning back in readable form by default; send null to follow the organisation's setting again, leave the field out to keep what the key has", "title": "Reasoning Summaries Enabled" }, "routing_config_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "This key's own routing configuration; send null to fall back to the organisation's default, leave the field out to keep what the key has", "title": "Routing Config Id" } }, "title": "KeyUpdate", "type": "object" }, "KeyUsage": { "description": "What one key cost over a window, or what the calls no key made cost\n(`UsageByKey.keyless`).", "properties": { "cost_eur": { "description": "What this total cost, in euro as an exact decimal, at the price in force for each of its rows when that row was recorded", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Cost Eur", "type": "string" }, "key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The key these rows were metered under; null on `keyless`, for the calls a person made from the console or a management route", "title": "Key Id" }, "rows": { "description": "How many usage rows this total sums", "title": "Rows", "type": "integer" }, "unpriced": { "description": "How many of this total's rows no price covered. Those rows cost zero, so a total with unpriced above zero is a floor on what was actually spent", "title": "Unpriced", "type": "integer" } }, "required": [ "key_id", "rows", "cost_eur", "unpriced" ], "title": "KeyUsage", "type": "object" }, "KeyUsageCap": { "description": "The same, for one registered key.", "properties": { "cost_cap_eur": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Ceiling on what this subject may spend in the period, in euro; null when it has no cap, and 0 for a real cap of nothing at all. The key's own cap is weighed before its organisation's", "title": "Cost Cap Eur" }, "cost_cap_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When cost_cap_eur stops binding: the end of this period, for a cap set for this month only; null for a standing cap and where there is no cap", "title": "Cost Cap Until" }, "cost_eur": { "description": "What was spent in the period, in euro as an exact decimal, over every priced kind -- tokens, images, tool invocations, retrieval, parsing, crawling", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Cost Eur", "type": "string" }, "key_id": { "description": "The key this cap and total are for", "title": "Key Id", "type": "string" } }, "required": [ "cost_cap_eur", "cost_eur", "key_id" ], "title": "KeyUsageCap", "type": "object" }, "KeyView": { "description": "`GET /key`: what the calling key can see about itself -- effective capabilities only.\n\nA caller can always ask which capabilities its key has; unlike `KeyRead`, this is never\nbuilt `from_attributes` off the row directly, since `capabilities` here is the effective\nset computed for this request, not the raw stored registration.", "properties": { "callback_secret_set": { "description": "Whether this key's run callbacks are signed (`Artific-Signature`); a key creates or replaces its secret with `POST /key/callback-secret`", "title": "Callback Secret Set", "type": "boolean" }, "capabilities": { "additionalProperties": false, "description": "Effective capability configs for this key, this request", "properties": { "agents": { "$ref": "#/components/schemas/AgentsConfig" }, "artifacts": { "$ref": "#/components/schemas/ArtifactsConfig" }, "assist": { "$ref": "#/components/schemas/AssistConfig" }, "compaction": { "$ref": "#/components/schemas/CompactionConfig" }, "computer": { "$ref": "#/components/schemas/ComputerConfig" }, "datastores": { "$ref": "#/components/schemas/DatastoresConfig" }, "evaluations": { "$ref": "#/components/schemas/EvaluationsConfig" }, "files": { "$ref": "#/components/schemas/FilesConfig" }, "improvements": { "$ref": "#/components/schemas/ImprovementsConfig" }, "knowledge": { "$ref": "#/components/schemas/KnowledgeConfig" }, "management": { "$ref": "#/components/schemas/ManagementConfig" }, "memory": { "$ref": "#/components/schemas/MemoryConfig" }, "product_events": { "$ref": "#/components/schemas/ProductEventsConfig" }, "prompts": { "$ref": "#/components/schemas/PromptsConfig" }, "pseudonymisation": { "$ref": "#/components/schemas/PseudonymisationConfig" }, "runs": { "$ref": "#/components/schemas/RunsConfig" }, "schedules": { "$ref": "#/components/schemas/SchedulesConfig" }, "skills": { "$ref": "#/components/schemas/SkillsConfig" }, "subjects": { "$ref": "#/components/schemas/SubjectsConfig" }, "tasks": { "$ref": "#/components/schemas/TasksConfig" }, "threads": { "$ref": "#/components/schemas/ThreadsConfig" }, "tooling": { "$ref": "#/components/schemas/ToolingConfig" }, "trust_envelope": { "$ref": "#/components/schemas/TrustEnvelopeConfig" }, "workflows": { "$ref": "#/components/schemas/WorkflowsConfig" } }, "title": "Capabilities", "type": "object" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this key stops authenticating anything; null for a key that never expires -- a caller can always ask when its own credential dies", "title": "Expires At" }, "id": { "description": "API key id", "title": "Id", "type": "string" }, "monthly_cost_cap_eur": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Ceiling on what this key may spend in a calendar month (UTC), in euro; null when it has none. Its organisation's own cap is not here -- a key reads that, and what it has spent, through `GET /usage/caps`", "title": "Monthly Cost Cap Eur" }, "monthly_cost_cap_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the key's monthly cap stops binding -- the end of the cap period it was set in -- or null for a standing cap. A cap past it binds nobody and is still shown here", "title": "Monthly Cost Cap Until" }, "name": { "description": "Human-readable key name", "title": "Name", "type": "string" }, "policy": { "$ref": "#/components/schemas/PolicyDocument", "description": "The policy document this key calls under: its rules and settings" }, "reasoning_summaries": { "description": "Whether this key's turns on a thinking model ask for the model's reasoning back in readable form when the request and its agent do not say -- the key's own setting, or its organisation's when the key has none", "title": "Reasoning Summaries", "type": "boolean" }, "residency": { "anyOf": [ { "$ref": "#/components/schemas/ResidencyView" }, { "type": "null" } ], "description": "Where this key's calls may go under its organisation's document and its own together: the regions they meet at and the residency exceptions both make; null when neither document names regions, so nothing holds the key to any" }, "routing_config": { "anyOf": [ { "$ref": "#/components/schemas/RoutingConfigView" }, { "type": "null" } ], "description": "The routing configuration actually in force for this key -- its own, or its organisation's default -- or null when it falls over to nothing" }, "secret_prefix": { "description": "The first twelve characters of this key's secret, so a caller can confirm which of its keys it is calling with", "title": "Secret Prefix", "type": "string" }, "tenant_id": { "description": "Owning tenant id", "title": "Tenant Id", "type": "string" }, "vendors_allow": { "description": "What this key's calls hold the vendor of a destination to: each `vendors_allow` of the documents it is decided under -- the organisations above, its organisation's, its own -- asked one by one, every one of which must admit it. Empty when none names one", "items": { "$ref": "#/components/schemas/VendorRequirement" }, "title": "Vendors Allow", "type": "array" } }, "required": [ "id", "tenant_id", "secret_prefix", "name", "capabilities", "policy", "monthly_cost_cap_eur", "monthly_cost_cap_until", "expires_at", "callback_secret_set", "routing_config", "reasoning_summaries", "residency", "vendors_allow" ], "title": "KeyView", "type": "object" }, "KnowledgeConfig": { "additionalProperties": false, "description": "The `knowledge` capability. No configuration yet.", "properties": {}, "title": "KnowledgeConfig", "type": "object" }, "LabelAmong": { "additionalProperties": false, "description": "Holds when the thing's values for `label` and the named person's values for `attribute`\noverlap.", "properties": { "atom": { "const": "label_among", "default": "label_among", "description": "holds when the thing's values for the label and the person's values for an attribute overlap", "title": "Atom", "type": "string" }, "attribute": { "description": "the attribute of the person whose values the label's values must overlap", "pattern": "^[A-Za-z0-9_.:-]{1,64}$", "title": "Attribute", "type": "string" }, "label": { "description": "the label read off the thing; `subject` is a row's own subject id, read on the five row kinds only and refused on every other", "pattern": "^[A-Za-z0-9_.:-]{1,64}$", "title": "Label", "type": "string" } }, "required": [ "label", "attribute" ], "title": "LabelAmong", "type": "object" }, "LabelDefinition": { "additionalProperties": false, "description": "One label an organisation declares: which values it admits, which kinds of thing may carry\nit, and whether a request may assert it about the person it is for.\n\n`values: null` is *any string*, which is what a label whose values are client names or ids\nhas to be. A closed set is the stronger declaration and the one that catches a typo in a\nvalue as well as in a name.", "properties": { "attribute": { "default": false, "description": "whether a request may assert this name about the person it is for; false makes it a label things carry and nobody claims", "title": "Attribute", "type": "boolean" }, "description": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "type": "null" } ], "description": "one sentence for whoever writes a rule or classifies a row against this label, shown by the console beside the name", "title": "Description" }, "kinds": { "description": "the kinds of thing this label classifies, from the rule kinds whose things carry labels; a rule reading it under another kind, and a row of another kind carrying it, are both refused", "items": { "enum": [ "model", "tool", "prompt", "skill", "agent", "schedule", "workflow", "knowledge_collection", "knowledge_index", "knowledge_graph", "thread", "memory_record", "knowledge_source", "stored_file", "datastore_record" ], "type": "string" }, "maxItems": 15, "minItems": 1, "title": "Kinds", "type": "array" }, "multiple": { "default": false, "description": "whether a row may carry a list of values under this label; false refuses a list wherever a row's labels are checked against the vocabulary, which is every kind except schedules, not checked yet. A row's `metadata` is never checked", "title": "Multiple", "type": "boolean" }, "values": { "anyOf": [ { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 128, "type": "array" }, { "type": "null" } ], "description": "every value this label may take, or null for any string; at most 128 distinct values, and a rule naming a value outside a closed set is refused", "title": "Values" } }, "required": [ "kinds" ], "title": "LabelDefinition", "type": "object" }, "LabelIsSubject": { "additionalProperties": false, "description": "Holds when the named person's own id is among the thing's values for `label`.", "properties": { "atom": { "const": "label_is_subject", "default": "label_is_subject", "description": "holds when the id of the person the request names is among the thing's values for the label", "title": "Atom", "type": "string" }, "label": { "description": "the label read off the thing; `subject` is a row's own subject id, read on the five row kinds only and refused on every other", "pattern": "^[A-Za-z0-9_.:-]{1,64}$", "title": "Label", "type": "string" } }, "required": [ "label" ], "title": "LabelIsSubject", "type": "object" }, "LabelVocabulary": { "additionalProperties": false, "description": "Every label one organisation declared, by name.\n\n`{}` -- a vocabulary declaring nothing -- is a real answer and the strictest one there is:\nevery *name* is then refused, because none of them is declared. It is not \"every rule is\nrefused\", and the difference matters. A condition over the implicit `subject` label names\nnothing declarable and is exempt, so the defaults for threads, memory and files -- which are\nwritten over `subject` alone -- still pass, as does any rule an organisation wrote over\n`subject` itself. A library row carrying no labels and a request asserting no attributes pass\nfor the same reason: there is no name to refuse.\n\n*No vocabulary at all* is the open one, and it is spelled by the column being null rather\nthan by an empty object here.", "properties": { "labels": { "default": {}, "description": "the labels this organisation declares, by name; at most 32, and never the implicit label `subject`", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "$ref": "#/components/schemas/LabelDefinition" } }, "title": "Labels", "type": "object" } }, "title": "LabelVocabulary", "type": "object" }, "LabelVocabularyRead": { "description": "What both label-vocabulary twins answer: the names this organisation declared, or `null`\nwhen it declared none.\n\n`null` rather than an empty `LabelVocabulary` for an organisation that declared nothing,\nbecause the two are opposite answers: no vocabulary admits every name, and a vocabulary\ndeclaring no label refuses every one of them\n(`docs/architecture/subjects.md` \"The vocabulary: which names a rule may use\"). A console card\nthat could not tell them apart would offer to \"clear\" a declaration that is already absent,\nand would show the strictest possible setting to an organisation that has none.", "properties": { "vocabulary": { "anyOf": [ { "$ref": "#/components/schemas/LabelVocabulary" }, { "type": "null" } ], "description": "the labels this organisation declared, each with the values and kinds it admits and whether a request may assert it; null when it declared none, which admits every name" } }, "required": [ "vocabulary" ], "title": "LabelVocabularyRead", "type": "object" }, "LessonSettings": { "additionalProperties": false, "description": "Whether the maintenance pass draws a lesson from one person's alike sessions, as a record\nof her own (`docs/architecture/knowledge-and-memory.md#personal-lessons`).\nOff by default: each lesson is a metered model call.", "properties": { "enabled": { "default": false, "description": "whether the maintenance pass writes a `lesson` record for a person from her own episodes that went alike; off by default, since each lesson is a metered call to the organisation's helper model", "title": "Enabled", "type": "boolean" }, "max_per_pass": { "default": 5, "description": "most lessons asked of the helper model in this store per pass, which bounds what one pass spends", "maximum": 20.0, "minimum": 1.0, "title": "Max Per Pass", "type": "integer" }, "min_episodes": { "default": 3, "description": "how many of one person's episodes, all with the same clear reaction and every two of them alike, make a group a lesson is drawn from", "maximum": 10.0, "minimum": 2.0, "title": "Min Episodes", "type": "integer" }, "similarity": { "default": 0.8, "description": "cosine similarity at or above which two of a person's episodes are alike", "maximum": 1.0, "minimum": 0.5, "title": "Similarity", "type": "number" } }, "title": "LessonSettings", "type": "object" }, "ListedPriceRead": { "description": "A catalogue price in the currency its price-list row is in: the vendor's own figure where\nno markup applies, with every markup in it where one does -- the same price as the euro\namounts beside it, before the rate.", "properties": { "cache_write_per_million_tokens": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Price of one million input tokens written to the cache in `currency`, as an exact decimal string; never converted or rounded here", "title": "Cache Write Per Million Tokens" }, "cached_input_per_million_tokens": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Price of one million cache-served input tokens in `currency`, as an exact decimal string; never converted or rounded here", "title": "Cached Input Per Million Tokens" }, "currency": { "description": "ISO 4217 code of the currency the price list holds it in", "title": "Currency", "type": "string" }, "input_per_million_tokens": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Price of one million input tokens in `currency`, as an exact decimal string; never converted or rounded here", "title": "Input Per Million Tokens" }, "output_per_million_tokens": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Price of one million output tokens in `currency`, as an exact decimal string; never converted or rounded here", "title": "Output Per Million Tokens" }, "per_unit": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Price of one generated image, or one minute of transcribed audio for an audio model, in `currency`, as an exact decimal string; never converted or rounded here", "title": "Per Unit" } }, "required": [ "currency", "input_per_million_tokens", "output_per_million_tokens", "cached_input_per_million_tokens", "cache_write_per_million_tokens", "per_unit" ], "title": "ListedPriceRead", "type": "object" }, "LiveCheck": { "additionalProperties": false, "description": "One rule a live turn is held to: on the caller's message or on the answer.", "properties": { "alert": { "anyOf": [ { "$ref": "#/components/schemas/LiveCheckAlert" }, { "type": "null" } ], "description": "a failure rate over the check's last results that raises one notification a day through the organisation's channels; unset, the check never alerts" }, "description": { "anyOf": [ { "maxLength": 300, "type": "string" }, { "type": "null" } ], "description": "the author's own sentence for the rule, at most 300 characters: what a recovery round will tell the model the answer broke. Unset, that is `expected` for a judged kind and the name for a pattern. The name, never this, is what a caller is shown", "title": "Description" }, "expected": { "anyOf": [ { "maxLength": 8192, "type": "string" }, { "type": "null" } ], "description": "the author's own text, as on an offline check: what the text must or must not contain, or -- for `must_use_tool` -- the tool's name, null meaning any tool", "title": "Expected" }, "judge_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the model that judges this check; judged kinds only. Unset, the turn's own model judges it, which an agent whose model is a router cannot leave unset", "title": "Judge Model" }, "kind": { "description": "which rule this check applies, as offline", "enum": [ "contains_text", "not_contains", "matches_pattern", "must_use_tool", "response_time", "correct_format", "polite_tone", "no_hallucination", "llm_judge" ], "title": "Kind", "type": "string" }, "max_match": { "anyOf": [ { "maximum": 200.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "how many characters a match of `pattern` can span at most, 1 to 200; `matches_pattern` only", "title": "Max Match" }, "mode": { "default": "block", "description": "`block` decides on the turn and stops it on a failure; `background` judges the answer after the turn, on a sample, and never touches it (judged kinds on the output only)", "enum": [ "block", "background" ], "title": "Mode", "type": "string" }, "name": { "description": "unique within its list -- an agent version's or an organisation's -- and named with that list's source wherever a result is recorded; what results name the check by, and shown to the caller of a turn it stops (`X-Core-Check`), so it holds no secret", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "title": "Name", "type": "string" }, "on_error": { "default": "block", "description": "what the turn does when this check's judge cannot decide -- it failed, timed out or was not allowed to run: `block` withholds as a failure does; `pass` lets the turn go on as if the check had passed, its result still recorded `errored` and counted toward its alert. A blocking judged check only; `pass` trades safety for availability, so it suits a check of tone, never one guarding confidential data", "enum": [ "block", "pass" ], "title": "On Error", "type": "string" }, "pattern": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "description": "the regular expression (RE2 syntax) whose match fails the check; `matches_pattern` only, refused when its longest match is unbounded or longer than `max_match`", "title": "Pattern" }, "recover": { "default": false, "description": "whether an answer this check fails is asked for again, at most the turn's agent version's `recover_attempts` times (2 for a turn with no agent), where the reply is not streamed; a blocking check on the output only", "title": "Recover", "type": "boolean" }, "sample": { "anyOf": [ { "maximum": 1.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "the share of turns a background check judges, decided from the response id; background checks only, 0.1 when unset", "title": "Sample" }, "stage": { "description": "`input`: the caller's text of this turn, before any model call; `output`: the answer, when a round ends with no tool call", "enum": [ "input", "output" ], "title": "Stage", "type": "string" }, "threshold": { "anyOf": [ { "maximum": 1.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "score a judged check passes at; judged kinds only", "title": "Threshold" } }, "required": [ "name", "stage", "kind" ], "title": "LiveCheck", "type": "object" }, "LiveCheckAlert": { "additionalProperties": false, "description": "When a check's results raise a notification: the share of its last `over_last` results\nthat did not pass, at which an organisation is told\n(`docs/architecture/live-checks.md#what-is-recorded`).", "properties": { "failure_rate": { "description": "the share of the last results, above 0 and at most 1, that did not pass (`failed` or `errored`) at which the organisation is notified", "exclusiveMinimum": 0.0, "maximum": 1.0, "title": "Failure Rate", "type": "number" }, "over_last": { "description": "how many of the check's latest results the rate is taken over; no alert is raised before the check has that many", "maximum": 1000.0, "minimum": 1.0, "title": "Over Last", "type": "integer" } }, "required": [ "failure_rate", "over_last" ], "title": "LiveCheckAlert", "type": "object" }, "MCPToolResultBlock": { "additionalProperties": false, "description": "What a tool Core ran answered, in the same assistant message as its call.", "properties": { "content": { "description": "the tool's output", "items": { "$ref": "#/components/schemas/TextBlock" }, "title": "Content", "type": "array" }, "is_error": { "description": "whether the tool failed", "title": "Is Error", "type": "boolean" }, "tool_use_id": { "description": "id of the mcp_tool_use block this answers", "title": "Tool Use Id", "type": "string" }, "type": { "const": "mcp_tool_result", "default": "mcp_tool_result", "description": "content block kind", "title": "Type", "type": "string" } }, "required": [ "tool_use_id", "is_error", "content" ], "title": "MCPToolResultBlock", "type": "object" }, "MCPToolUseBlock": { "additionalProperties": false, "description": "A call to a tool **Core** ran itself, on the server side of the turn.", "properties": { "id": { "description": "id correlating this call with its mcp_tool_result", "title": "Id", "type": "string" }, "input": { "additionalProperties": true, "description": "the call's arguments", "title": "Input", "type": "object" }, "name": { "description": "the tool's qualified name, as `GET /tools` lists it", "title": "Name", "type": "string" }, "server_name": { "description": "the tool's source, as `GET /tools` names it", "title": "Server Name", "type": "string" }, "type": { "const": "mcp_tool_use", "default": "mcp_tool_use", "description": "content block kind", "title": "Type", "type": "string" } }, "required": [ "id", "name", "server_name", "input" ], "title": "MCPToolUseBlock", "type": "object" }, "MailConnectorCreate": { "additionalProperties": false, "description": "Body of `POST /mail_connectors`.", "properties": { "auth": { "description": "How Core logs in: `basic` (one login for IMAP and SMTP), `oauth_client_credentials` (an application's token, sent as XOAUTH2 for `mailbox`) or `oauth_authorization_code` (each person's own token, sent as XOAUTH2 for the verified address their consent named; such a mailbox is never watched, and sends only for the service account whose own mailbox it is). Written once and never read back", "discriminator": { "mapping": { "basic": "#/components/schemas/BasicAuth", "oauth_authorization_code": "#/components/schemas/OAuthAuthorizationCodeAuth", "oauth_client_credentials": "#/components/schemas/OAuthClientCredentialsAuth" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/BasicAuth" }, { "$ref": "#/components/schemas/OAuthClientCredentialsAuth" }, { "$ref": "#/components/schemas/OAuthAuthorizationCodeAuth" } ], "title": "Auth" }, "ca_pem": { "anyOf": [ { "maxLength": 65536, "type": "string" }, { "type": "null" } ], "description": "The certificate authority the IMAP and SMTP servers' certificates are checked against, as PEM; omitted checks them against the public authorities. The certificate must name the host either way", "title": "Ca Pem" }, "description": { "description": "What this mailbox is for, shown to the model with each tool", "maxLength": 1024, "title": "Description", "type": "string" }, "drafts_folder": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The folder a draft is saved to; omitted offers no draft tool", "title": "Drafts Folder" }, "folders": { "description": "The folders the tools may search, read, mark and move between; the first is the one a tool uses when none is named", "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "title": "Folders", "type": "array" }, "from_address": { "anyOf": [ { "maxLength": 254, "minLength": 3, "type": "string" }, { "type": "null" } ], "description": "The From of every mail sent and every draft; the model never sets it", "title": "From Address" }, "imap": { "$ref": "#/components/schemas/MailServer", "description": "The IMAP server the tools read through" }, "mailbox": { "anyOf": [ { "maxLength": 254, "minLength": 3, "type": "string" }, { "type": "null" } ], "description": "The mailbox an application's token opens; required with `oauth_client_credentials`, refused with `basic`", "title": "Mailbox" }, "max_recipients": { "default": 10, "description": "At most this many To and Cc per send", "maximum": 50.0, "minimum": 1.0, "title": "Max Recipients", "type": "integer" }, "name": { "description": "Connector name, unique per tenant; the model sees `mail____`", "pattern": "^[a-z0-9_-]{1,48}$", "title": "Name", "type": "string" }, "region": { "anyOf": [ { "pattern": "^(eu|us|in-cluster|global|[a-z]{2})$", "type": "string" }, { "type": "null" } ], "description": "Where this connector's servers are, as you assert it, spelled as `policy.settings.regions_allow` is; judged as an API connector's region is", "title": "Region" }, "send_allowed_domains": { "description": "The recipient domains a send may address, exactly; empty offers no send", "items": { "maxLength": 253, "pattern": "^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?(\\.[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)+$", "type": "string" }, "maxItems": 50, "title": "Send Allowed Domains", "type": "array" }, "sends_per_hour": { "default": 20, "description": "At most this many sends per clock hour", "maximum": 1000.0, "minimum": 1.0, "title": "Sends Per Hour", "type": "integer" }, "smtp": { "anyOf": [ { "$ref": "#/components/schemas/MailServer" }, { "type": "null" } ], "description": "The SMTP server a send goes through; omitted offers no send" }, "watch": { "anyOf": [ { "$ref": "#/components/schemas/MailWatch" }, { "type": "null" } ], "description": "Notice new mail in one folder and produce a `mail.received` event for each message; omitted watches nothing" } }, "required": [ "name", "description", "imap", "auth" ], "title": "MailConnectorCreate", "type": "object" }, "MailConnectorRead": { "description": "A mail connector, as `POST`/`GET`/`PATCH` return it: the registration and its latest\nversion's fields flat.", "properties": { "auth": { "$ref": "#/components/schemas/SourceAuthRead", "description": "How Core logs in; never the secret" }, "ca_pem": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The certificate authority the servers are checked against; null for the public ones", "title": "Ca Pem" }, "created_at": { "description": "When it was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created it", "title": "Created By", "type": "string" }, "description": { "description": "What this mailbox is for, shown to the model", "title": "Description", "type": "string" }, "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "drafts_folder": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The folder a draft is saved to", "title": "Drafts Folder" }, "egress": { "description": "Every host a call through this connector dials -- its IMAP and SMTP servers and its token endpoint -- each with whether the organisation's allowed hosts permit it and whether the deployment blocks it, as of this read", "items": { "$ref": "#/components/schemas/HostAccess" }, "title": "Egress", "type": "array" }, "folders": { "description": "The folders the tools may touch", "items": { "type": "string" }, "title": "Folders", "type": "array" }, "from_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The From of every mail sent and every draft", "title": "From Address" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "id": { "description": "Mail connector id", "title": "Id", "type": "string" }, "imap": { "$ref": "#/components/schemas/MailServer", "description": "The IMAP server" }, "latest_version": { "description": "The highest published version, which keys read and turns run; 0 for a connector with only drafts", "title": "Latest Version", "type": "integer" }, "mailbox": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The mailbox an application's token opens", "title": "Mailbox" }, "max_recipients": { "description": "At most this many To and Cc per send", "title": "Max Recipients", "type": "integer" }, "name": { "description": "Connector name; the model sees `mail____`", "title": "Name", "type": "string" }, "object": { "const": "mail_connector", "default": "mail_connector", "description": "The object's type", "title": "Object", "type": "string" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Where the servers are, as the registrant asserted", "title": "Region" }, "send_allowed_domains": { "description": "The domains a send may address", "items": { "type": "string" }, "title": "Send Allowed Domains", "type": "array" }, "sends_per_hour": { "description": "At most this many sends per clock hour", "title": "Sends Per Hour", "type": "integer" }, "smtp": { "anyOf": [ { "$ref": "#/components/schemas/MailServer" }, { "type": "null" } ], "description": "The SMTP server; null sends nothing" }, "tools": { "description": "The qualified names of the tools this version offers", "items": { "type": "string" }, "title": "Tools", "type": "array" }, "updated_at": { "description": "When it was last updated", "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "description": "The version the flat fields are: the latest published one, or, for a connector with only drafts, which only the management twin reads, its newest draft", "title": "Version", "type": "integer" }, "watch": { "anyOf": [ { "$ref": "#/components/schemas/MailWatch" }, { "type": "null" } ], "description": "The watch new mail is noticed by; null for none" }, "watch_polled_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the watch's last poll ended", "title": "Watch Polled At" }, "watch_status": { "anyOf": [ { "enum": [ "pending", "ok", "denied", "unreachable", "auth_failed", "refused" ], "type": "string" }, { "type": "null" } ], "description": "What the watch's last poll found: `pending` before the first, `ok`, `denied` (the host or its address is not allowed), `unreachable`, `auth_failed` or `refused`; null while nothing is watched", "title": "Watch Status" } }, "required": [ "id", "name", "description", "imap", "smtp", "folders", "drafts_folder", "from_address", "send_allowed_domains", "max_recipients", "sends_per_hour", "watch", "ca_pem", "tools", "auth", "mailbox", "region", "version", "latest_version", "created_by", "created_at", "updated_at" ], "title": "MailConnectorRead", "type": "object" }, "MailConnectorTestRead": { "description": "What `POST /mail_connectors/{id}/test` found: an IMAP login and the first folder opened\nread-only, and an SMTP greeting and login when the connector sends. Nothing is stored.", "properties": { "imap": { "$ref": "#/components/schemas/MailServerCheck", "description": "The IMAP server's answer" }, "smtp": { "anyOf": [ { "$ref": "#/components/schemas/MailServerCheck" }, { "type": "null" } ], "description": "The SMTP server's answer; null sends nothing" } }, "required": [ "imap", "smtp" ], "title": "MailConnectorTestRead", "type": "object" }, "MailConnectorUpdate": { "additionalProperties": false, "description": "Body of `PATCH /mail_connectors/{id}`; every field is optional and left alone when absent.\n`name` never changes. A change to what the connector does writes a new version; `auth`,\n`mailbox` and `region` are the registration's and write none.", "properties": { "auth": { "anyOf": [ { "discriminator": { "mapping": { "basic": "#/components/schemas/BasicAuth", "oauth_authorization_code": "#/components/schemas/OAuthAuthorizationCodeAuth", "oauth_client_credentials": "#/components/schemas/OAuthClientCredentialsAuth" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/BasicAuth" }, { "$ref": "#/components/schemas/OAuthClientCredentialsAuth" }, { "$ref": "#/components/schemas/OAuthAuthorizationCodeAuth" } ] }, { "type": "null" } ], "description": "New credential, replacing the stored one; omitted keeps it", "title": "Auth" }, "ca_pem": { "anyOf": [ { "maxLength": 65536, "type": "string" }, { "type": "null" } ], "description": "New certificate authority; an explicit null goes back to the public authorities, and an omitted field leaves it alone", "title": "Ca Pem" }, "description": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "New description", "title": "Description" }, "drafts_folder": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "New drafts folder; an explicit null offers no draft tool", "title": "Drafts Folder" }, "folders": { "anyOf": [ { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array" }, { "type": "null" } ], "description": "New folders", "title": "Folders" }, "from_address": { "anyOf": [ { "maxLength": 254, "minLength": 3, "type": "string" }, { "type": "null" } ], "description": "New From address; an explicit null stops drafts and sends", "title": "From Address" }, "imap": { "anyOf": [ { "$ref": "#/components/schemas/MailServer" }, { "type": "null" } ], "description": "New IMAP server" }, "mailbox": { "anyOf": [ { "maxLength": 254, "minLength": 3, "type": "string" }, { "type": "null" } ], "description": "New mailbox an application's token opens", "title": "Mailbox" }, "max_recipients": { "anyOf": [ { "maximum": 50.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "New recipient limit", "title": "Max Recipients" }, "region": { "anyOf": [ { "pattern": "^(eu|us|in-cluster|global|[a-z]{2})$", "type": "string" }, { "type": "null" } ], "description": "New region; an explicit null clears it", "title": "Region" }, "send_allowed_domains": { "anyOf": [ { "items": { "maxLength": 253, "pattern": "^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?(\\.[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)+$", "type": "string" }, "maxItems": 50, "type": "array" }, { "type": "null" } ], "description": "New allowed domains; [] stops sending", "title": "Send Allowed Domains" }, "sends_per_hour": { "anyOf": [ { "maximum": 1000.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "New hour limit", "title": "Sends Per Hour" }, "smtp": { "anyOf": [ { "$ref": "#/components/schemas/MailServer" }, { "type": "null" } ], "description": "New SMTP server; an explicit null stops sending" }, "watch": { "anyOf": [ { "$ref": "#/components/schemas/MailWatch" }, { "type": "null" } ], "description": "New watch; an explicit null stops watching" } }, "title": "MailConnectorUpdate", "type": "object" }, "MailConnectorVersionRead": { "description": "One immutable version of a mail connector.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "ca_pem": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The certificate authority the servers are checked against; null for the public ones", "title": "Ca Pem" }, "connector_id": { "description": "Connector this version belongs to", "title": "Connector Id", "type": "string" }, "created_at": { "description": "When it was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created it", "title": "Created By", "type": "string" }, "description": { "description": "What this mailbox is for, shown to the model", "title": "Description", "type": "string" }, "drafts_folder": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The folder a draft is saved to", "title": "Drafts Folder" }, "folders": { "description": "The folders the tools may touch", "items": { "type": "string" }, "title": "Folders", "type": "array" }, "from_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The From of every mail sent and every draft", "title": "From Address" }, "id": { "description": "Mail connector version id", "title": "Id", "type": "string" }, "imap": { "$ref": "#/components/schemas/MailServer", "description": "The IMAP server" }, "max_recipients": { "description": "At most this many To and Cc per send", "title": "Max Recipients", "type": "integer" }, "object": { "const": "mail_connector_version", "default": "mail_connector_version", "description": "The object's type", "title": "Object", "type": "string" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "send_allowed_domains": { "description": "The domains a send may address", "items": { "type": "string" }, "title": "Send Allowed Domains", "type": "array" }, "sends_per_hour": { "description": "At most this many sends per clock hour", "title": "Sends Per Hour", "type": "integer" }, "smtp": { "anyOf": [ { "$ref": "#/components/schemas/MailServer" }, { "type": "null" } ], "description": "The SMTP server; null sends nothing" }, "state": { "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" }, "watch": { "anyOf": [ { "$ref": "#/components/schemas/MailWatch" }, { "type": "null" } ], "description": "The watch new mail is noticed by; null for none" } }, "required": [ "id", "connector_id", "version", "description", "imap", "smtp", "folders", "drafts_folder", "from_address", "send_allowed_domains", "max_recipients", "sends_per_hour", "watch", "ca_pem", "state", "created_by", "acted_for", "created_at" ], "title": "MailConnectorVersionRead", "type": "object" }, "MailServer": { "additionalProperties": false, "description": "One server a mail connector reaches: TLS from the first byte (`implicit_tls`, IMAP 993 and\nSMTP 465) or upgraded before anything else is said (`starttls`, IMAP 143 and SMTP 587). There\nis no plain-text choice.", "properties": { "host": { "description": "The server's host name", "maxLength": 253, "pattern": "^[A-Za-z0-9]([A-Za-z0-9.-]{0,251}[A-Za-z0-9])?$", "title": "Host", "type": "string" }, "port": { "description": "The server's port", "maximum": 65535.0, "minimum": 1.0, "title": "Port", "type": "integer" }, "security": { "description": "`implicit_tls`, or `starttls` (the upgrade is required, never optional)", "enum": [ "implicit_tls", "starttls" ], "title": "Security", "type": "string" } }, "required": [ "host", "port", "security" ], "title": "MailServer", "type": "object" }, "MailServerCheck": { "description": "What one server answered a connectivity check.", "properties": { "code": { "description": "`ok`; `denied` (the host or its address is not allowed); `unreachable`; `auth_failed`; `refused` (the server refused the first folder or the login step)", "enum": [ "ok", "denied", "unreachable", "auth_failed", "refused" ], "title": "Code", "type": "string" }, "ok": { "description": "Whether Core reached the server and logged in", "title": "Ok", "type": "boolean" } }, "required": [ "ok", "code" ], "title": "MailServerCheck", "type": "object" }, "MailWatch": { "additionalProperties": false, "description": "Noticing new mail: the folder polled and how often. Each new message is one\n`mail.received` event, which a workflow's event trigger starts a run from.", "properties": { "enabled": { "default": true, "description": "Whether the mailbox is polled at all", "title": "Enabled", "type": "boolean" }, "folder": { "description": "The folder watched; one of the connector's `folders`", "maxLength": 255, "minLength": 1, "title": "Folder", "type": "string" }, "poll_seconds": { "default": 300, "description": "How often the mailbox is asked for new mail, in seconds; at least the deployment's floor (`CORE_MAIL_WATCH_MIN_POLL_SECONDS`, 60 by default)", "maximum": 86400.0, "minimum": 1.0, "title": "Poll Seconds", "type": "integer" } }, "required": [ "folder" ], "title": "MailWatch", "type": "object" }, "MaintenanceSettings": { "additionalProperties": false, "description": "What the periodic `memory.maintain` pass does to this store's records.", "properties": { "archive_after_days": { "default": 90, "description": "days without a write, a confirmation or a recall before a faded record may be archived", "maximum": 3650.0, "minimum": 1.0, "title": "Archive After Days", "type": "integer" }, "archive_below_confidence": { "anyOf": [ { "maximum": 1.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "default": 0.1, "description": "effective confidence under which a record not recalled for `archive_after_days` is archived; null never archives", "title": "Archive Below Confidence" }, "contradiction_check": { "default": false, "description": "whether near records that are not duplicates are judged for a contradiction by the organisation's helper model; each judgement is a metered model call", "title": "Contradiction Check", "type": "boolean" }, "contradiction_max_pairs": { "default": 20, "description": "most pairs judged in this store per pass, which bounds what one pass spends", "maximum": 200.0, "minimum": 1.0, "title": "Contradiction Max Pairs", "type": "integer" }, "contradiction_similarity": { "default": 0.8, "description": "cosine similarity at or above which two records are compared for a contradiction", "maximum": 1.0, "minimum": 0.5, "title": "Contradiction Similarity", "type": "number" }, "dedupe_threshold": { "default": 0.95, "description": "cosine similarity at or above which two current records of the same person and type are one fact; the weaker is superseded into the stronger", "maximum": 1.0, "minimum": 0.5, "title": "Dedupe Threshold", "type": "number" }, "enabled": { "default": true, "description": "whether the maintenance pass runs over this store at all", "title": "Enabled", "type": "boolean" } }, "title": "MaintenanceSettings", "type": "object" }, "ManagementConfig": { "additionalProperties": false, "description": "The `management` capability: this key administers its own organisation and the ones below\nit, exactly as a tenant administrator whose one root is that organisation does\n(`docs/architecture/tenancy.md` \"Who may do what\").\n\nNo configuration: what the key may do is decided per call by the functions that answer for a\nperson, and a second place to narrow it would be a second answer. No dependency: administering\nan organisation is not administering its data.", "properties": {}, "title": "ManagementConfig", "type": "object" }, "MarkupCreate": { "additionalProperties": false, "description": "`POST /tenants/{tenant_id}/markups` and `POST /organisation/markups`: what this\norganisation adds to the price of one subject, for itself or for everything below it, from\none instant onward.\n\nThe organisation is the path's or the calling key's, never a field: a markup names the\norganisation that is *paid* it, and an organisation typing another one's id would be setting\nwhat somebody else charges.", "properties": { "cache_write_eur_per_million_tokens": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Added to the price of one million input tokens the provider wrote to its cache, in euro, as an exact decimal string; never rounded here", "title": "Cache Write Eur Per Million Tokens" }, "cached_input_eur_per_million_tokens": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Added to the price of one million input tokens the provider served from its cache, in euro, as an exact decimal string; never rounded here", "title": "Cached Input Eur Per Million Tokens" }, "effective_from": { "description": "Instant from which this markup applies; may be in the past, which re-costs every period back to it, or in the future, which announces a markup ahead", "format": "date-time", "title": "Effective From", "type": "string" }, "eur_per_unit": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Added to the price of one metered unit in euro, as an exact decimal string; never rounded here", "title": "Eur Per Unit" }, "input_eur_per_million_tokens": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Added to the price of one million input tokens in euro, as an exact decimal string; never rounded here", "title": "Input Eur Per Million Tokens" }, "kind": { "anyOf": [ { "enum": [ "model_tokens", "cached_tokens", "cache_write_tokens", "embedding_tokens", "tool_invocation", "retrieval", "crawl_pages", "parse_pages", "image_generation", "sandbox_seconds", "shared_bytes", "thread_turn", "run", "compaction_run", "schedule_fire", "task_start", "agent_turn", "evaluation_scenario", "datastore_write", "memory_write", "file_upload", "pseudonymised_turn", "improvement_analysis", "workflow_run", "audio_transcription", "speech_synthesis", "decision" ], "type": "string" }, { "type": "null" } ], "description": "Usage kind this markup applies to; leave it out to mark up every kind", "title": "Kind" }, "model": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "description": "Model id, for model_tokens, embedding_tokens and image_generation; leave it out to mark up every model of that kind, and refused for a kind that names no model", "title": "Model" }, "output_eur_per_million_tokens": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Added to the price of one million output tokens in euro, as an exact decimal string; never rounded here", "title": "Output Eur Per Million Tokens" }, "percent": { "anyOf": [ { "minimum": -100.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Percentage added to the resolved price: 20 is +20%, -15 is a 15% discount, -100 is free. Leave it out to add absolute amounts instead; a markup names one form or the other, never both", "title": "Percent" }, "scope": { "description": "Who this markup applies to: 'self' is this organisation itself, 'descendants' is every organisation below it and never this one. Refused with a negative percent on 'self': an organisation may raise what it is charged and never lower it, because that is the figure its own cap is weighed on", "enum": [ "self", "descendants" ], "title": "Scope", "type": "string" }, "tool_name": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "description": "Tool name, for tool_invocation; leave it out to mark up every tool, and refused for a kind that names no tool", "title": "Tool Name" } }, "required": [ "effective_from", "scope" ], "title": "MarkupCreate", "type": "object" }, "MarkupRead": { "description": "One markup row, as every markup route returns it.", "properties": { "cache_write_eur_per_million_tokens": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Added to the price of one million input tokens written to the cache in euro, as an exact decimal string; never rounded here", "title": "Cache Write Eur Per Million Tokens" }, "cached_input_eur_per_million_tokens": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Added to the price of one million cache-served input tokens in euro, as an exact decimal string; never rounded here", "title": "Cached Input Eur Per Million Tokens" }, "created_at": { "description": "When this markup row was written", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "'operator:' for a markup a person typed, or the id of the key that typed it", "title": "Created By", "type": "string" }, "effective_from": { "description": "Instant from which this markup applies", "format": "date-time", "title": "Effective From", "type": "string" }, "eur_per_unit": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Added to the price of one metered unit in euro, as an exact decimal string; never rounded here", "title": "Eur Per Unit" }, "id": { "description": "Markup id", "title": "Id", "type": "string" }, "input_eur_per_million_tokens": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Added to the price of one million input tokens in euro, as an exact decimal string; never rounded here", "title": "Input Eur Per Million Tokens" }, "kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Usage kind this markup applies to; null marks up every kind", "title": "Kind" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Model id this markup applies to; null marks up every model of its kind", "title": "Model" }, "object": { "const": "markup", "default": "markup", "description": "The object's type", "title": "Object", "type": "string" }, "output_eur_per_million_tokens": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Added to the price of one million output tokens in euro, as an exact decimal string; never rounded here", "title": "Output Eur Per Million Tokens" }, "percent": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Percentage added to the resolved price; null when this row adds amounts", "title": "Percent" }, "scope": { "description": "Who this markup applies to: 'self' is the organisation itself, 'descendants' is every organisation below it", "enum": [ "self", "descendants" ], "title": "Scope", "type": "string" }, "tenant_id": { "description": "Organisation that set this markup and is paid it", "title": "Tenant Id", "type": "string" }, "tool_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tool name this markup applies to; null marks up every tool", "title": "Tool Name" } }, "required": [ "id", "tenant_id", "scope", "kind", "model", "tool_name", "percent", "input_eur_per_million_tokens", "output_eur_per_million_tokens", "cached_input_eur_per_million_tokens", "cache_write_eur_per_million_tokens", "eur_per_unit", "effective_from", "created_by", "created_at" ], "title": "MarkupRead", "type": "object" }, "Match": { "additionalProperties": false, "description": "Which things of its kind a rule is about: any of `names`, carrying all of `labels`.", "properties": { "labels": { "default": {}, "description": "labels the thing must carry, each with this value among its values; all must hold. `subject` is a row's own subject id, read on the five row kinds only and refused on every other, and the empty string on it is a shared row. A thing without the label, or whose value holds no string, does not match. Refused on kinds whose things carry no labels: `egress_host`, `router`, `file`, `datastore`, the three acts and `direct_turn`", "maxProperties": 16, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "maxLength": 512, "type": "string" } }, "title": "Labels", "type": "object" }, "names": { "anyOf": [ { "items": { "maxLength": 200, "minLength": 1, "type": "string" }, "maxItems": 200, "minItems": 1, "type": "array" }, { "type": "null" } ], "description": "patterns the thing's name must match one of: fnmatch globs with case, or, on kind `egress_host`, a hostname or a '*.suffix' wildcard. Omitted or null is every name. Refused on a kind that has no name: the five row kinds, the three acts and `direct_turn`", "title": "Names" } }, "title": "Match", "type": "object" }, "McpApprovalRequestOutput": { "additionalProperties": false, "description": "A call a background run parked until a person decides it, in place of the call: the\nResponses API's own `mcp_approval_request`. Decided through\n`POST /responses/{id}/approvals/{approval_id}` with this item's `id`.", "properties": { "arguments": { "description": "the call's arguments, as it will run (JSON text)", "title": "Arguments", "type": "string" }, "id": { "description": "the approval request's id", "title": "Id", "type": "string" }, "name": { "description": "the tool's name", "title": "Name", "type": "string" }, "server_label": { "description": "where the tool comes from, as `mcp_call` names it", "title": "Server Label", "type": "string" }, "type": { "const": "mcp_approval_request", "default": "mcp_approval_request", "description": "output item kind", "title": "Type", "type": "string" } }, "required": [ "id", "server_label", "name", "arguments" ], "title": "McpApprovalRequestOutput", "type": "object" }, "McpCallOutput": { "additionalProperties": false, "description": "One tool round Core ran itself: the call the model made, and what came back.\n\nA tool Core executes is, from the caller's side, a call the *server* made on its behalf --\nwhich is what the Responses API's `mcp_call` item is for, and why a Core-run round is one\n`mcp_call` rather than a `function_call` followed by a `function_call_output`. Upstream\nnever puts a `function_call_output` in an `output[]`: it is an input-only item there, and\nCore agrees (`docs/architecture/responses.md`, \"A tool round Core ran itself\").", "properties": { "approval_request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the approval request that held this call, in a background run queued with `tool_approval`; null for a call that waited for nobody", "title": "Approval Request Id" }, "arguments": { "description": "the call's arguments, as emitted (JSON text)", "title": "Arguments", "type": "string" }, "error": { "anyOf": [ { "$ref": "#/components/schemas/McpToolExecutionError" }, { "type": "null" } ], "description": "why the call produced no output, when it produced none" }, "id": { "description": "the item's id", "title": "Id", "type": "string" }, "name": { "description": "the tool's qualified name", "title": "Name", "type": "string" }, "output": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the tool's output text; null while the call is still running, and null when it failed", "title": "Output" }, "routed": { "default": false, "description": "whether the model reached this tool through the tool router, writing a `builtin__tool_run` call naming it (Core extension); `name` is the tool's own either way", "title": "Routed", "type": "boolean" }, "server_label": { "description": "where the tool came from, as `GET /tools` names its source: `api`, `mcp__`, `knowledge`, `memory`, `builtin`, `core` or `alias`", "title": "Server Label", "type": "string" }, "status": { "description": "`in_progress` while the result is not in view, else how the call ended", "enum": [ "in_progress", "completed", "failed" ], "title": "Status", "type": "string" }, "type": { "const": "mcp_call", "default": "mcp_call", "description": "output item kind", "title": "Type", "type": "string" } }, "required": [ "id", "server_label", "name", "arguments", "status" ], "title": "McpCallOutput", "type": "object" }, "McpServerCreate": { "additionalProperties": false, "description": "Body of `POST /mcp_servers`.", "properties": { "allowed_tools": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Tool names this registration offers; None means no restriction", "title": "Allowed Tools" }, "auth": { "anyOf": [ { "discriminator": { "mapping": { "bearer": "#/components/schemas/BearerAuth", "none": "#/components/schemas/NoAuth", "oauth_authorization_code": "#/components/schemas/OAuthAuthorizationCodeAuth", "oauth_client_credentials": "#/components/schemas/OAuthClientCredentialsAuth" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/NoAuth" }, { "$ref": "#/components/schemas/BearerAuth" }, { "$ref": "#/components/schemas/OAuthClientCredentialsAuth" }, { "$ref": "#/components/schemas/OAuthAuthorizationCodeAuth" } ] }, { "type": "null" } ], "description": "How Core authenticates to this server; omitted means none. An MCP transport carries headers and no query string, so the kinds are `none`, `bearer` and `oauth_client_credentials`", "title": "Auth" }, "background": { "anyOf": [ { "$ref": "#/components/schemas/ToolBackground" }, { "type": "null" } ], "description": "whether a turn may start this server's tools as tasks, for how long, and whether a call may be sent again after an interruption; omitted means never" }, "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this server's headers read: a JSON Schema object with one property per `{@name}` in `headers`, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; they stand only in header values, never in the URL, and are never offered to the model. Every `{@name}` must be declared and every declaration used, and a name may not also be an install value; omitted declares none" }, "headers": { "additionalProperties": { "maxLength": 4096, "type": "string" }, "description": "Headers every request to this server carries, by name. A value may hold `{$name}` install values and `{@name}` call variables, filled in at each call; a header that holds a call variable is left off the worker's tool-list sync, which has no request to take one from. proxy-authorization and cookie, a header Core or the transport sets, and the header this server's own `auth` is sent in are refused; authorization is accepted only when the server's `auth` is none; omitted sends none", "maxProperties": 32, "title": "Headers", "type": "object" }, "install_values": { "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/InstallValue" }, { "$ref": "#/components/schemas/SecretInstallValue" }, { "$ref": "#/components/schemas/KeptSecret" } ] }, "description": "A typed value for every `{$name}` in `url` and `headers`, by name: `{type, value, allowed, description}`, a `string`, `number` or `enum` as a shared bundle's parameters are, or a `secret`. Percent-encoded in the URL's path or query and as text in a header value; never in the scheme, host or port. Every token needs a value and every value must be used, and a value may not contain `{` or `}`. A `secret` (at most 8,192 characters) is sealed, filled in at call time, stands only in a header value, and is read back as `{type: \"secret\", has_value}`; a write replacing the values carries it again or `{\"$keep\": true}`. A copy a publication installed carries the installer's plain values already written in, and only its secrets here", "maxProperties": 64, "title": "Install Values", "type": "object" }, "labels": { "default": {}, "description": "The organisation's classification of this server, as label -> value; what the rules over `tool` read", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the registration, at most 16 KiB serialised: stored, returned and never read by Core; omitted or null stores {}", "title": "Metadata" }, "name": { "description": "Model-visible server name, unique per tenant", "pattern": "^[a-z0-9_-]{1,32}$", "title": "Name", "type": "string" }, "region": { "anyOf": [ { "pattern": "^(eu|us|in-cluster|global|[a-z]{2})$", "type": "string" }, { "type": "null" } ], "description": "where this server's host is served, as you assert it: a jurisdiction ('eu', 'us', 'in-cluster', 'global') or an ISO 3166-1 alpha-2 country code ('nl'), spelled exactly as `policy.settings.regions_allow` is. A key whose `regions_allow` narrows it reaches the host only when an entry of its list contains this region ('nl' lies inside 'eu', everything inside 'global'), and never past a `host_regions` entry of the key's or the organisation's policy that places the host more widely -- unless every strict document names the host in `policy.settings.region_exceptions`. Omitted or null leaves the host to those `policy.settings.host_regions` alone", "title": "Region" }, "url": { "description": "http(s) endpoint of the server", "maxLength": 2048, "pattern": "^https?://", "title": "Url", "type": "string" }, "vendor": { "anyOf": [ { "$ref": "#/components/schemas/VendorOrigin" }, { "type": "null" } ], "description": "who runs this host, as you state it: where the company serving it is established (`established_in`) and where that company's ultimate parent is (`parent_in`), each a zone ('eu', 'us', 'global') or an ISO 3166-1 alpha-2 country code, never 'in-cluster'. A key or organisation whose `policy.settings.vendors_allow` names places reaches the host only when they contain what is stated; a fact left out is 'global', which only a requirement naming 'global' admits" } }, "required": [ "name", "url" ], "title": "McpServerCreate", "type": "object" }, "McpServerRead": { "description": "One registered MCP server, as `POST`/`GET`/`PATCH` return it.", "properties": { "allowed_tools": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Tool names this registration offers; None means no restriction", "title": "Allowed Tools" }, "auth": { "$ref": "#/components/schemas/SourceAuthRead", "description": "How Core authenticates to this server" }, "background": { "anyOf": [ { "$ref": "#/components/schemas/ToolBackground" }, { "type": "null" } ], "description": "whether this server's tools may be started as tasks, for how long, and whether a call may be sent again after an interruption; null is never" }, "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this server's headers read: a JSON Schema object with one property per `{@name}` in `headers`, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; they stand only in header values, never in the URL, and are never offered to the model. Every `{@name}` must be declared and every declaration used, and a name may not also be an install value. A sealed copy answers them too, because a caller must know what to send; the headers that place them stay withheld" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/CoverRead" }, { "type": "null" } ], "description": "The picture this organisation put on this server, the one every tool of it falls back to; null when it has none, and the image itself is read from its own `.../cover` route" }, "created_at": { "description": "When this server was registered", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created this server", "title": "Created By", "type": "string" }, "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "egress": { "description": "Every host a call through this source dials -- its own, and its token endpoint's where its credential names one -- each with whether the organisation's allowed hosts permit it and whether the deployment blocks it, as of this read. A host that is not allowed, or is blocked, is refused at the first call; an administrator adds it under the organisation's allowed hosts", "items": { "$ref": "#/components/schemas/HostAccess" }, "title": "Egress", "type": "array" }, "headers": { "additionalProperties": { "type": "string" }, "description": "Headers every request to this server carries, by name. A value may hold `{$name}` install values and `{@name}` call variables, filled in at each call; a header that holds a call variable is left off the worker's tool-list sync, which has no request to take one from. proxy-authorization and cookie, a header Core or the transport sets, and the header this server's own `auth` is sent in are refused; authorization is accepted only when the server's `auth` is none; empty for a copy a sealed publication installed", "title": "Headers", "type": "object" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "id": { "description": "MCP server id", "title": "Id", "type": "string" }, "install_values": { "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/InstallValue" }, { "$ref": "#/components/schemas/SecretInstallValueRead" } ] }, "description": "A typed value for every `{$name}` in `url` and `headers`, by name: `{type, value, allowed, description}`, a `string`, `number` or `enum` as a shared bundle's parameters are, or a `secret`. Percent-encoded in the URL's path or query and as text in a header value; never in the scheme, host or port. Every token needs a value and every value must be used, and a value may not contain `{` or `}`. A `secret` (at most 8,192 characters) is sealed, filled in at call time, stands only in a header value, and is read back as `{type: \"secret\", has_value}`; a write replacing the values carries it again or `{\"$keep\": true}`. A copy a publication installed carries the installer's plain values already written in, and only its secrets here; empty for a sealed copy", "title": "Install Values", "type": "object" }, "labels": { "default": {}, "description": "The organisation's classification of this server, as label -> value; every tool it offers carries it", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "last_sync_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why the last tool sync failed; null when it succeeded or never ran. A server whose last sync failed offers no tools until one succeeds", "title": "Last Sync Error" }, "last_synced_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When a tool sync last ran for this server, successful or not; null means it has never run and the server offers no tools yet", "title": "Last Synced At" }, "latest_version": { "default": 1, "description": "The highest published version, which the url, headers, values, offered tools and background setting are; 0 for a server with only drafts, which only the management twin reads, as its newest draft", "title": "Latest Version", "type": "integer" }, "metadata": { "additionalProperties": true, "default": {}, "description": "The opaque document attached to this registration; {} when none was set", "title": "Metadata", "type": "object" }, "name": { "description": "Model-visible server name, unique per tenant", "title": "Name", "type": "string" }, "object": { "const": "mcp_server", "default": "mcp_server", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/OriginRead" }, { "type": "null" } ], "description": "where this registration came from when a subscription installed it; null for one this organisation registered itself" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "where this server's host is served, as its registrant asserted it; null when nobody did, and the key's own `policy.settings.host_regions` then places the host", "title": "Region" }, "tool_count": { "description": "How many tools the last successful sync stored, whether or not `allowed_tools` offers them", "title": "Tool Count", "type": "integer" }, "updated_at": { "description": "When this server was last updated", "format": "date-time", "title": "Updated At", "type": "string" }, "url": { "description": "http(s) endpoint of the server; a copy a sealed publication installed answers the origin only -- scheme and host -- so a subscriber can still see where its keys call", "title": "Url", "type": "string" }, "vendor": { "$ref": "#/components/schemas/VendorOrigin", "description": "who runs this host, as its registrant stated it; each fact null where nobody did, which `policy.settings.vendors_allow` reads as 'global'" } }, "required": [ "id", "name", "url", "allowed_tools", "auth", "vendor", "last_synced_at", "last_sync_error", "tool_count", "created_by", "created_at", "updated_at" ], "title": "McpServerRead", "type": "object" }, "McpServerUpdate": { "additionalProperties": false, "description": "Body of `PATCH /mcp_servers/{server_id}`; every field is optional and left alone when\nabsent -- `name` never changes after creation, so it has no field here.", "properties": { "allowed_tools": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "new allowlist of tool names this registration offers", "title": "Allowed Tools" }, "auth": { "anyOf": [ { "discriminator": { "mapping": { "bearer": "#/components/schemas/BearerAuth", "none": "#/components/schemas/NoAuth", "oauth_authorization_code": "#/components/schemas/OAuthAuthorizationCodeAuth", "oauth_client_credentials": "#/components/schemas/OAuthClientCredentialsAuth" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/NoAuth" }, { "$ref": "#/components/schemas/BearerAuth" }, { "$ref": "#/components/schemas/OAuthClientCredentialsAuth" }, { "$ref": "#/components/schemas/OAuthAuthorizationCodeAuth" } ] }, { "type": "null" } ], "description": "new credential, replacing whatever is stored; omitted leaves it alone", "title": "Auth" }, "background": { "anyOf": [ { "$ref": "#/components/schemas/ToolBackground" }, { "type": "null" } ], "description": "new background setting, replacing whatever is stored; an explicit null clears it back to never, and a body that omits the field leaves it alone" }, "call_variables": { "anyOf": [ { "$ref": "#/components/schemas/CallVariables" }, { "type": "null" } ], "description": "new call variables, replacing the whole declaration; omitted leaves them alone. The call variables this server's headers read: a JSON Schema object with one property per `{@name}` in `headers`, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; they stand only in header values, never in the URL, and are never offered to the model. Every `{@name}` must be declared and every declaration used, and a name may not also be an install value" }, "headers": { "anyOf": [ { "additionalProperties": { "maxLength": 4096, "type": "string" }, "maxProperties": 32, "type": "object" }, { "type": "null" } ], "description": "new headers, replacing every stored one; omitted leaves them alone, and {} clears them. Headers every request to this server carries, by name. A value may hold `{$name}` install values and `{@name}` call variables, filled in at each call; a header that holds a call variable is left off the worker's tool-list sync, which has no request to take one from. proxy-authorization and cookie, a header Core or the transport sets, and the header this server's own `auth` is sent in are refused; authorization is accepted only when the server's `auth` is none", "title": "Headers" }, "install_values": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/InstallValue" }, { "$ref": "#/components/schemas/SecretInstallValue" }, { "$ref": "#/components/schemas/KeptSecret" } ] }, "maxProperties": 64, "type": "object" }, { "type": "null" } ], "description": "new install values, replacing every stored one; omitted leaves them alone, and {} clears them. A typed value for every `{$name}` in `url` and `headers`, by name: `{type, value, allowed, description}`, a `string`, `number` or `enum` as a shared bundle's parameters are, or a `secret`. Percent-encoded in the URL's path or query and as text in a header value; never in the scheme, host or port. Every token needs a value and every value must be used, and a value may not contain `{` or `}`. A `secret` (at most 8,192 characters) is sealed, filled in at call time, stands only in a header value, and is read back as `{type: \"secret\", has_value}`; a write replacing the values carries it again or `{\"$keep\": true}`. A copy a publication installed carries the installer's plain values already written in, and only its secrets here", "title": "Install Values" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "new classification of this server, replacing whatever is stored; omitted leaves it alone, and an empty map clears it", "title": "Labels" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "new opaque document, replacing whatever is stored whole; omitted leaves it alone, and {} clears it", "title": "Metadata" }, "region": { "anyOf": [ { "pattern": "^(eu|us|in-cluster|global|[a-z]{2})$", "type": "string" }, { "type": "null" } ], "description": "new region this server's host is served in, replacing whatever is stored. An explicit null clears it, leaving the host to the key's own `policy.settings.host_regions`; a field the body omits leaves the stored region alone", "title": "Region" }, "url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https?://", "type": "string" }, { "type": "null" } ], "description": "new http(s) endpoint", "title": "Url" }, "vendor": { "anyOf": [ { "$ref": "#/components/schemas/VendorOrigin" }, { "type": "null" } ], "description": "new statement of who runs this host, replacing whatever is stored; an explicit null clears it back to nothing stated, and a body that omits the field leaves it alone" } }, "title": "McpServerUpdate", "type": "object" }, "McpServerVersionRead": { "description": "One immutable version of what a server dials, as\n`GET /mcp_servers/{server_id}/versions[/{version}]` returns it; withheld for a sealed copy as\nits server is.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "allowed_tools": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Tool names this version offers; None means no restriction", "title": "Allowed Tools" }, "background": { "anyOf": [ { "$ref": "#/components/schemas/ToolBackground" }, { "type": "null" } ], "description": "whether the server's tools may be started as tasks; null is never" }, "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this server's headers read: a JSON Schema object with one property per `{@name}` in `headers`, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; they stand only in header values, never in the URL, and are never offered to the model. Every `{@name}` must be declared and every declaration used, and a name may not also be an install value" }, "created_at": { "description": "When this version was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created this version", "title": "Created By", "type": "string" }, "headers": { "additionalProperties": { "type": "string" }, "description": "Headers every request to this server carries, by name. A value may hold `{$name}` install values and `{@name}` call variables, filled in at each call; a header that holds a call variable is left off the worker's tool-list sync, which has no request to take one from. proxy-authorization and cookie, a header Core or the transport sets, and the header this server's own `auth` is sent in are refused; authorization is accepted only when the server's `auth` is none; empty for a sealed copy", "title": "Headers", "type": "object" }, "install_values": { "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/InstallValue" }, { "$ref": "#/components/schemas/SecretInstallValueRead" } ] }, "description": "A typed value for every `{$name}` in `url` and `headers`, by name: `{type, value, allowed, description}`, a `string`, `number` or `enum` as a shared bundle's parameters are, or a `secret`. Percent-encoded in the URL's path or query and as text in a header value; never in the scheme, host or port. Every token needs a value and every value must be used, and a value may not contain `{` or `}`. A `secret` (at most 8,192 characters) is sealed, filled in at call time, stands only in a header value, and is read back as `{type: \"secret\", has_value}`; a write replacing the values carries it again or `{\"$keep\": true}`. A copy a publication installed carries the installer's plain values already written in, and only its secrets here; empty for a sealed copy", "title": "Install Values", "type": "object" }, "object": { "const": "mcp_server_version", "default": "mcp_server_version", "description": "The object's type", "title": "Object", "type": "string" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "server_id": { "description": "Server this version belongs to", "title": "Server Id", "type": "string" }, "state": { "default": "published", "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "url": { "description": "http(s) endpoint of the server; the origin only for a sealed copy", "title": "Url", "type": "string" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" } }, "required": [ "server_id", "version", "url", "allowed_tools", "headers", "install_values", "call_variables", "created_by", "acted_for", "created_at" ], "title": "McpServerVersionRead", "type": "object" }, "McpToolEcho": { "additionalProperties": false, "description": "A tool Core runs, as the vendor's server-side tool.\n\n`server_url` is always null: the tool is reached through Core, and the caller has no address\nfor it. `allowed_tools` names the one tool a `tool` reference admitted; a `toolset` stands\nfor whatever its globs match at the moment the turn runs, so it names none.", "properties": { "allowed_tools": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "the qualified tool names this entry admitted, when it names any", "title": "Allowed Tools" }, "server_label": { "description": "the tool's source, as `GET /tools` names it", "title": "Server Label", "type": "string" }, "server_url": { "description": "always null: Core runs the tool", "title": "Server Url", "type": "null" }, "type": { "const": "mcp", "default": "mcp", "description": "tool kind", "title": "Type", "type": "string" } }, "required": [ "server_label" ], "title": "McpToolEcho", "type": "object" }, "McpToolExecutionError": { "additionalProperties": false, "description": "Why a tool Core ran produced no result: the vendor's own error shape for a server-side\ntool call (`openai.types.responses.mcp_tool_call_error.McpToolExecutionError`).", "properties": { "content": { "description": "the failure in Core's own fixed wording -- `Denied by policy.`, `Unknown tool.`, and the rest -- never a provider's or an exception's own text", "title": "Content", "type": "string" }, "type": { "const": "mcp_tool_execution_error", "default": "mcp_tool_execution_error", "description": "the error's kind", "title": "Type", "type": "string" } }, "required": [ "content" ], "title": "McpToolExecutionError", "type": "object" }, "McpToolRead": { "description": "One tool a server's last sync stored, as `GET /mcp_servers/{server_id}/tools` lists it --\nevery synced row, not only the ones the registration currently offers; `offered` is what\ntells the two apart, so a console can pick a server's `allowed_tools` from the whole list\nrather than from what it already restricts to.", "properties": { "description": { "description": "What the tool does", "title": "Description", "type": "string" }, "input_schema": { "additionalProperties": true, "description": "JSON Schema object for the tool's arguments", "title": "Input Schema", "type": "object" }, "name": { "description": "The tool's name on the server", "title": "Name", "type": "string" }, "offered": { "description": "Whether the registration's own `allowed_tools` offers this tool -- true when `allowed_tools` is null (no restriction) or names this tool's name", "title": "Offered", "type": "boolean" }, "task_support": { "anyOf": [ { "enum": [ "required", "optional", "forbidden" ], "type": "string" }, { "type": "null" } ], "description": "What the server's listing declares about running this tool as a task of its own: `required` or `optional`, and a call a worker holds for a task is sent as the server's task and polled; `forbidden` or null -- nothing declared, or a server without tasks -- and the worker holds the one call open", "title": "Task Support" } }, "required": [ "name", "description", "input_schema", "offered", "task_support" ], "title": "McpToolRead", "type": "object" }, "MediaFloor": { "additionalProperties": false, "description": "The least an organisation demands of each class of media; null demands nothing.", "properties": { "audio": { "anyOf": [ { "enum": [ "allow", "self_hosted", "refuse" ], "type": "string" }, { "type": "null" } ], "description": "the floor for recordings", "title": "Audio" }, "images": { "anyOf": [ { "enum": [ "allow", "self_hosted", "refuse" ], "type": "string" }, { "type": "null" } ], "description": "the floor for images", "title": "Images" }, "speech": { "anyOf": [ { "enum": [ "allow", "self_hosted", "refuse" ], "type": "string" }, { "type": "null" } ], "description": "the floor for speech", "title": "Speech" } }, "title": "MediaFloor", "type": "object" }, "MediaRules": { "additionalProperties": false, "description": "What a hiding key sends of each class of media; today's behaviour by default.", "properties": { "audio": { "default": "allow", "description": "a recording sent to transcription, by any path", "enum": [ "allow", "self_hosted", "refuse" ], "title": "Audio", "type": "string" }, "images": { "default": "allow", "description": "an image part sent to a model and an image tool's reference images", "enum": [ "allow", "self_hosted", "refuse" ], "title": "Images", "type": "string" }, "speech": { "default": "refuse", "description": "text sent to a speech model, whose audio no placeholder can be restored in", "enum": [ "allow", "self_hosted", "refuse" ], "title": "Speech", "type": "string" } }, "title": "MediaRules", "type": "object" }, "MemberReport": { "additionalProperties": false, "description": "Which members this configuration leaves out.", "properties": { "skipped": { "description": "Members whose condition the parameter values in this body do not meet; they are not installed, and every other section of this report leaves them out", "items": { "type": "string" }, "title": "Skipped", "type": "array" } }, "title": "MemberReport", "type": "object" }, "MemberSelector": { "additionalProperties": false, "description": "One row of the publisher's own library to put in the bundle.\n\n`auth` is the one thing an export cannot decide by itself, and it is asked here rather than\nguessed: a connector or a server the publisher registered may hold a credential, and what\nhappens to it -- travel with the bundle, be asked of every subscriber, or be dropped -- is a\ndecision only the publisher can make. A row that holds one and says nothing is refused.", "properties": { "auth": { "anyOf": [ { "enum": [ "carried", "parameter", "none" ], "type": "string" }, { "type": "null" } ], "description": "what happens to this row's credential, for an api_connector, an mcp_server or a sql_connector: 'carried' seals the publisher's own into the version (a subtree publication only), 'parameter' asks every subscriber for one, 'none' shares it unauthenticated. Required for a row that holds a credential, and refused for every other kind", "title": "Auth" }, "auth_parameter": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "the credential parameter subscribers supply, for `auth: parameter`", "title": "Auth Parameter" }, "id": { "description": "the row's own id", "maxLength": 64, "title": "Id", "type": "string" }, "kind": { "description": "which library the id belongs to", "enum": [ "prompt", "skill", "toolset", "agent", "collection", "pipeline", "index", "retrieval_tool", "evaluation", "api_connector", "mcp_server", "sql_connector", "tool_alias", "script", "workflow" ], "title": "Kind", "type": "string" }, "parameterise": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Parameterised" }, "maxItems": 32, "type": "array" }, { "type": "null" } ], "description": "the fields of this row the installer fills in instead of the publisher, each bound to a parameter declared in the same request", "title": "Parameterise" }, "when": { "anyOf": [ { "$ref": "#/components/schemas/When" }, { "type": "null" } ], "description": "the condition this member installs under, over one enum parameter declared in the same request; null installs it always" } }, "required": [ "kind", "id" ], "title": "MemberSelector", "type": "object" }, "MemoryConfig": { "additionalProperties": false, "description": "The `memory` capability: retrieval, writes, automatic injection and decay.", "properties": { "decay": { "additionalProperties": { "$ref": "#/components/schemas/DecayRule" }, "default": {}, "description": "per memory-type decay rules; a type absent here never decays", "title": "Decay", "type": "object" }, "injection": { "$ref": "#/components/schemas/MemoryInjectionConfig", "description": "automatic injection rules" }, "retrieval_tool": { "default": true, "description": "whether a run may call the memory retrieval tool", "title": "Retrieval Tool", "type": "boolean" }, "write_tool": { "default": true, "description": "whether a run may call the memory write tool", "title": "Write Tool", "type": "boolean" } }, "title": "MemoryConfig", "type": "object" }, "MemoryCreate": { "additionalProperties": false, "description": "Body of `POST /memory`: exactly one of `text`/`structured` must be set.", "properties": { "confidence": { "default": 1.0, "description": "Confidence at write time", "maximum": 1.0, "minimum": 0.0, "title": "Confidence", "type": "number" }, "due_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When a commitment is due; only for type 'commitment'", "title": "Due At" }, "index_id": { "description": "Knowledge index this record belongs to", "minLength": 1, "title": "Index Id", "type": "string" }, "labels": { "default": {}, "description": "labels the rules over this row's kind read, as label -> a value or a list of 1 to 32 distinct values, each of 1 to 256 characters; at most 32 names. Held to the organisation's vocabulary and, for a request naming a person, to `writable_labels`", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Opaque metadata, matched by a list's metadata filter", "maxProperties": 16, "title": "Metadata", "type": "object" }, "owed_to": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Who a commitment is owed to, as it was said; only for type 'commitment'", "title": "Owed To" }, "status": { "anyOf": [ { "enum": [ "open", "fulfilled", "cancelled" ], "type": "string" }, { "type": "null" } ], "description": "A commitment's status; required for, and only for, type 'commitment'", "title": "Status" }, "structured": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Structured content", "title": "Structured" }, "supersedes": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "A current record in the same index this one corrects: the old record keeps its text, leaves search and injection, and stays readable through its history", "title": "Supersedes" }, "text": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Text content (<= 32 KiB, UTF-8 encoded)", "title": "Text" }, "type": { "description": "Caller-declared type; Core never interprets it", "pattern": "^[A-Za-z0-9_.:-]{1,64}$", "title": "Type", "type": "string" } }, "required": [ "index_id", "type" ], "title": "MemoryCreate", "type": "object" }, "MemoryExtractionCounts": { "description": "What this store's extraction has done since the switch was first set.", "properties": { "confirmed": { "description": "Current records extraction found said again", "title": "Confirmed", "type": "integer" }, "dropped": { "description": "Candidates refused as invalid and never stored", "title": "Dropped", "type": "integer" }, "extracted": { "description": "Records extraction wrote", "title": "Extracted", "type": "integer" }, "superseded": { "description": "Records an extracted correction replaced", "title": "Superseded", "type": "integer" } }, "required": [ "extracted", "confirmed", "superseded", "dropped" ], "title": "MemoryExtractionCounts", "type": "object" }, "MemoryExtractionPut": { "additionalProperties": false, "description": "Body of `PUT /memory/stores/{index_id}/extraction`: the whole switch.", "properties": { "enabled": { "description": "Switch extraction on (making or updating its knowledge objects) or off (removing its connector; what was extracted stays)", "title": "Enabled", "type": "boolean" }, "episodes": { "default": false, "description": "Also write one `episode` record for each settled session, read with the same model from the moment episodes go on, never back into history", "title": "Episodes", "type": "boolean" }, "filters": { "$ref": "#/components/schemas/ConversationFilters", "description": "Which threads are read, and in what windows" }, "instructions": { "default": "", "description": "The organisation's own instructions on what is worth remembering", "maxLength": 2000, "title": "Instructions", "type": "string" }, "lessons": { "default": false, "description": "Also let the episode digest write up to three `lesson` records for a session's person: a reusable way of working, or a mistake and how it was recovered. Same model call, nothing for a thread naming nobody; needs `episodes`", "title": "Lessons", "type": "boolean" }, "model": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Chat model that reads the conversations; required to switch extraction on", "title": "Model" }, "schedule_cron": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "type": "null" } ], "description": "Five-field cron expression read in `schedule_timezone`, instead of `schedule_minutes`", "title": "Schedule Cron" }, "schedule_minutes": { "anyOf": [ { "maximum": 44640.0, "minimum": 5.0, "type": "integer" }, { "type": "null" } ], "default": 60, "description": "Minutes between reads of the conversations; mutually exclusive with `schedule_cron`", "title": "Schedule Minutes" }, "schedule_timezone": { "default": "UTC", "description": "IANA zone `schedule_cron` is read in", "maxLength": 64, "title": "Schedule Timezone", "type": "string" }, "threads": { "default": "with_person", "description": "Which threads are mined: `with_person` only those that name a person, `all` every settled thread. A conversation for nobody is read as the organisation's own, so mining it writes a person's private fact as a shared one that every colleague's turns are shown; choose `all` only when every thread is shared on purpose", "enum": [ "with_person", "all" ], "title": "Threads", "type": "string" }, "types": { "description": "Memory types extraction may write; `commitment` adds status, due time and who it is owed to", "items": { "pattern": "^[A-Za-z0-9_.:-]{1,64}$", "type": "string" }, "maxItems": 20, "minItems": 1, "title": "Types", "type": "array" } }, "required": [ "enabled" ], "title": "MemoryExtractionPut", "type": "object" }, "MemoryExtractionRead": { "additionalProperties": false, "description": "A memory store's extraction switch, as both twins answer it.", "properties": { "collection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The collection of conversation windows; null until enabled", "title": "Collection Id" }, "connector_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The `conversations` connector; null while switched off", "title": "Connector Id" }, "counts": { "$ref": "#/components/schemas/MemoryExtractionCounts", "description": "What extraction has written so far" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the switch was first set; null when never", "title": "Created At" }, "enabled": { "description": "Whether extraction is switched on", "title": "Enabled", "type": "boolean" }, "episodes": { "default": false, "description": "Also write one `episode` record for each settled session, read with the same model from the moment episodes go on, never back into history", "title": "Episodes", "type": "boolean" }, "filters": { "$ref": "#/components/schemas/ConversationFilters", "description": "Which threads are read, and in what windows" }, "index_id": { "description": "The knowledge index whose memory store this fills", "title": "Index Id", "type": "string" }, "instructions": { "default": "", "description": "The organisation's own instructions on what is worth remembering", "maxLength": 2000, "title": "Instructions", "type": "string" }, "last_sync": { "anyOf": [ { "$ref": "#/components/schemas/SyncRunRead" }, { "type": "null" } ], "description": "The connector's most recent sync run, when there is one" }, "lessons": { "default": false, "description": "Also let the episode digest write up to three `lesson` records for a session's person: a reusable way of working, or a mistake and how it was recovered. Same model call, nothing for a thread naming nobody; needs `episodes`", "title": "Lessons", "type": "boolean" }, "model": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Chat model that reads the conversations; required to switch extraction on", "title": "Model" }, "object": { "const": "memory_extraction", "default": "memory_extraction", "description": "The object's type", "title": "Object", "type": "string" }, "pipeline_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ingest pipeline made from `memory/extract`", "title": "Pipeline Id" }, "pipeline_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The pipeline version the index is pinned to", "title": "Pipeline Version" }, "schedule_cron": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "type": "null" } ], "description": "Five-field cron expression read in `schedule_timezone`, instead of `schedule_minutes`", "title": "Schedule Cron" }, "schedule_minutes": { "anyOf": [ { "maximum": 44640.0, "minimum": 5.0, "type": "integer" }, { "type": "null" } ], "default": 60, "description": "Minutes between reads of the conversations; mutually exclusive with `schedule_cron`", "title": "Schedule Minutes" }, "schedule_timezone": { "default": "UTC", "description": "IANA zone `schedule_cron` is read in", "maxLength": 64, "title": "Schedule Timezone", "type": "string" }, "state": { "description": "`off`; `active`; or why a switch that is on cannot run: `objects_missing` (its connector is gone or the index no longer runs its pipeline; set the switch again), `author_unavailable` (the key that last set it was revoked or has expired, so every sync fails `auth_failed`; set the switch again) or `model_unavailable` (the model is no longer served to this organisation; name another)", "enum": [ "off", "active", "objects_missing", "author_unavailable", "model_unavailable" ], "title": "State", "type": "string" }, "threads": { "default": "with_person", "description": "Which threads are mined: `with_person` only those that name a person, `all` every settled thread. A conversation for nobody is read as the organisation's own, so mining it writes a person's private fact as a shared one that every colleague's turns are shown; choose `all` only when every thread is shared on purpose", "enum": [ "with_person", "all" ], "title": "Threads", "type": "string" }, "types": { "description": "Memory types extraction may write; `commitment` adds status, due time and who it is owed to", "items": { "pattern": "^[A-Za-z0-9_.:-]{1,64}$", "type": "string" }, "maxItems": 20, "minItems": 1, "title": "Types", "type": "array" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the switch was last written; null when never", "title": "Updated At" }, "windows": { "$ref": "#/components/schemas/MemoryExtractionWindows", "description": "The conversation windows the index holds, by state, and the commonest failure among them" } }, "required": [ "index_id", "enabled", "state", "counts", "windows" ], "title": "MemoryExtractionRead", "type": "object" }, "MemoryExtractionWindows": { "description": "The conversation windows the store's index holds, by what became of each.", "properties": { "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The fixed failure code most failed windows carry; null when none failed", "title": "Error Code" }, "failed": { "description": "Windows whose last reading failed; nothing was extracted", "title": "Failed", "type": "integer" }, "parked": { "description": "Windows held until the month turns, at the monthly cap", "title": "Parked", "type": "integer" }, "queued": { "description": "Windows waiting to be read or being read now", "title": "Queued", "type": "integer" }, "ready": { "description": "Windows read, whether or not anything was worth remembering", "title": "Ready", "type": "integer" } }, "required": [ "ready", "failed", "queued", "parked" ], "title": "MemoryExtractionWindows", "type": "object" }, "MemoryInjectionConfig": { "additionalProperties": false, "description": "Whether and how memory is injected into a run without an explicit retrieval call.", "properties": { "budget_tokens": { "default": 1500, "description": "most tokens the injected block may cost, counted as four characters per token over every rendered line with its fields; the store's own budget and the deployment's ceiling can only lower it", "maximum": 8000.0, "minimum": 100.0, "title": "Budget Tokens", "type": "integer" }, "enabled": { "default": false, "description": "whether memory is injected automatically", "title": "Enabled", "type": "boolean" }, "index_id": { "anyOf": [ { "pattern": "idx_[0-9A-Za-z]{1,64}", "type": "string" }, { "type": "null" } ], "description": "index injected memory is drawn from; required when enabled. It must be an index of this organisation that the writer's policy names, checked when the key or agent version carrying it is written; a turn whose calling key's policy does not name it is handed nothing", "title": "Index Id" }, "limit": { "default": 20, "description": "most memories injected per run", "maximum": 100.0, "minimum": 1.0, "title": "Limit", "type": "integer" }, "metadata": { "additionalProperties": { "type": "string" }, "default": {}, "description": "metadata filter injected memory must match", "title": "Metadata", "type": "object" }, "min_confidence": { "default": 0.0, "description": "minimum confidence for a memory to be injected", "maximum": 1.0, "minimum": 0.0, "title": "Min Confidence", "type": "number" }, "types": { "default": [], "description": "memory types eligible for injection; empty means all types", "items": { "type": "string" }, "title": "Types", "type": "array" } }, "title": "MemoryInjectionConfig", "type": "object" }, "MemoryRead": { "description": "A memory record as a key reads it on `GET /memory` and `GET /memory/{memory_id}`.\n\n`effective_confidence` is computed at read time (decay never rewrites the stored\n`confidence`); `provenance` is null for an explicit write and names the source items, never\ntheir trust, for a derived one. No `trust` and no `authority`: what a caller needs of the\nlabel is `origin`, under a name for what it is (`docs/architecture/decisions.md`).", "properties": { "archived_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the maintenance pass archived this record", "title": "Archived At" }, "confidence": { "description": "Confidence as stored, before decay", "title": "Confidence", "type": "number" }, "contested": { "description": "Whether the maintenance pass judged this record to contradict another", "title": "Contested", "type": "boolean" }, "contested_with": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The record this one was judged to contradict", "title": "Contested With" }, "created_at": { "description": "When this record was created, which is also when it became valid", "format": "date-time", "title": "Created At", "type": "string" }, "created_by_key_id": { "description": "Key that created this record", "title": "Created By Key Id", "type": "string" }, "due_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When a commitment is due", "title": "Due At" }, "effective_confidence": { "description": "Confidence after the reading credential's decay rules; equal to `confidence` on the management twin, which carries none", "title": "Effective Confidence", "type": "number" }, "first_item_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The first message an episode covers, to page the thread's items from; null for every other type", "title": "First Item Id" }, "id": { "description": "Memory record id", "title": "Id", "type": "string" }, "index_id": { "description": "Knowledge index this record belongs to", "title": "Index Id", "type": "string" }, "labels": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "the labels the rules over this row's kind read, as label -> a value or a list of values, read back exactly as written", "title": "Labels", "type": "object" }, "last_confirmed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the same fact was last written again or merged in as a duplicate", "title": "Last Confirmed At" }, "last_item_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The last message an episode covers; null for every other type", "title": "Last Item Id" }, "last_recalled_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When a search tool or an injection last recalled this record", "title": "Last Recalled At" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Opaque metadata", "title": "Metadata", "type": "object" }, "object": { "const": "memory_record", "default": "memory_record", "description": "The object's type", "title": "Object", "type": "string" }, "occurred_from": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When an episode's first message was written; null for every other type", "title": "Occurred From" }, "occurred_to": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When an episode's last message was written; null for every other type", "title": "Occurred To" }, "origin": { "description": "'written' for a record a caller created, 'derived' for one Core wrote from a turn's items", "enum": [ "written", "derived" ], "title": "Origin", "type": "string" }, "owed_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who a commitment is owed to", "title": "Owed To" }, "provenance": { "anyOf": [ { "$ref": "#/components/schemas/ProvenanceRead" }, { "type": "null" } ], "description": "Which items fed this record, when derived; null when written" }, "recall_count": { "description": "How many times a search tool or an injection handed this record to a model", "title": "Recall Count", "type": "integer" }, "state": { "description": "'current', 'superseded' or 'archived'; only a current record reaches a model", "enum": [ "current", "superseded", "archived" ], "title": "State", "type": "string" }, "status": { "anyOf": [ { "enum": [ "open", "fulfilled", "cancelled" ], "type": "string" }, { "type": "null" } ], "description": "A commitment's status; null for every other type", "title": "Status" }, "structured": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Structured content", "title": "Structured" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this record was written for, as the calling application named them; null for a record shared with everybody, and also null under a subject token reading a row that is not its own, even one a rule admitted it to", "title": "Subject" }, "superseded_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The record that replaced this one, when superseded", "title": "Superseded By" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Text content", "title": "Text" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The thread an episode tells of, which may since have been deleted; null for every other type", "title": "Thread Id" }, "type": { "description": "Caller-declared type", "title": "Type", "type": "string" }, "updated_at": { "description": "When this record was last written or updated", "format": "date-time", "title": "Updated At", "type": "string" }, "valid_to": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this record stopped being current; null while it is", "title": "Valid To" } }, "required": [ "id", "index_id", "type", "metadata", "labels", "confidence", "effective_confidence", "origin", "created_by_key_id", "created_at", "updated_at", "state", "recall_count", "contested" ], "title": "MemoryRead", "type": "object" }, "MemorySearch": { "additionalProperties": false, "description": "Body of `POST /memory/stores/{index_id}/search`.", "properties": { "after": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only records created at or after this instant (ISO 8601 with an offset)", "title": "After" }, "before": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only records created before this instant (ISO 8601 with an offset)", "title": "Before" }, "query": { "description": "search query text", "maxLength": 4096, "minLength": 1, "title": "Query", "type": "string" }, "top_k": { "default": 10, "description": "most hits returned", "maximum": 50.0, "minimum": 1.0, "title": "Top K", "type": "integer" }, "types": { "description": "memory types to match; empty matches any", "items": { "type": "string" }, "title": "Types", "type": "array" } }, "required": [ "query" ], "title": "MemorySearch", "type": "object" }, "MemorySearchHit": { "additionalProperties": false, "description": "One record a memory search ranked, as a key reads it.", "properties": { "record": { "$ref": "#/components/schemas/MemoryRead", "description": "The record" }, "score": { "description": "Its fused (or reranked) score; higher ranks first", "title": "Score", "type": "number" } }, "required": [ "record", "score" ], "title": "MemorySearchHit", "type": "object" }, "MemoryStoreRead": { "additionalProperties": false, "description": "One memory store as both the key-facing routes and the management twin answer it.", "properties": { "commitments": { "$ref": "#/components/schemas/CommitmentSettings", "description": "commitment injection" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this store was created; null when not yet configured", "title": "Created At" }, "decay": { "additionalProperties": { "$ref": "#/components/schemas/DecayRule" }, "description": "per memory-type decay defaults for this store; a key's own `memory.decay` overrides a type for that key's reads", "title": "Decay", "type": "object" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Memory store id; null for an index nothing has written memory into or configured yet, which reads as the defaults", "title": "Id" }, "index_id": { "description": "The knowledge index this store's records live in", "title": "Index Id", "type": "string" }, "injection": { "$ref": "#/components/schemas/InjectionSettings", "description": "limits on automatic injection" }, "lessons": { "$ref": "#/components/schemas/LessonSettings", "description": "lessons the maintenance pass draws from one person's alike sessions" }, "maintained_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the maintenance pass last finished a run over this store", "title": "Maintained At" }, "maintenance": { "$ref": "#/components/schemas/MaintenanceSettings", "description": "the maintenance pass" }, "object": { "const": "memory_store", "default": "memory_store", "description": "The object's type", "title": "Object", "type": "string" }, "promotion": { "$ref": "#/components/schemas/PromotionSettings", "description": "proposing a fact several people hold, or one that is general knowledge, as the organisation's" }, "search": { "$ref": "#/components/schemas/SearchSettings", "description": "extra search signals" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When its settings were last written; null when never", "title": "Updated At" } }, "required": [ "id", "index_id" ], "title": "MemoryStoreRead", "type": "object" }, "MemoryStoreUpdate": { "additionalProperties": false, "description": "Body of `PATCH /memory/stores/{index_id}`: each section named replaces that section whole;\nan absent section is left as it is.", "properties": { "commitments": { "anyOf": [ { "$ref": "#/components/schemas/CommitmentSettings" }, { "type": "null" } ], "description": "replacement commitment injection settings" }, "decay": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/DecayRule" }, "type": "object" }, { "type": "null" } ], "description": "replacement per-type decay defaults", "title": "Decay" }, "injection": { "anyOf": [ { "$ref": "#/components/schemas/InjectionSettings" }, { "type": "null" } ], "description": "replacement automatic injection limits" }, "lessons": { "anyOf": [ { "$ref": "#/components/schemas/LessonSettings" }, { "type": "null" } ], "description": "replacement lesson settings" }, "maintenance": { "anyOf": [ { "$ref": "#/components/schemas/MaintenanceSettings" }, { "type": "null" } ], "description": "replacement maintenance settings" }, "promotion": { "anyOf": [ { "$ref": "#/components/schemas/PromotionSettings" }, { "type": "null" } ], "description": "replacement promotion settings" }, "search": { "anyOf": [ { "$ref": "#/components/schemas/SearchSettings" }, { "type": "null" } ], "description": "replacement search signals" } }, "title": "MemoryStoreUpdate", "type": "object" }, "MemoryUpdate": { "additionalProperties": false, "description": "Body of `PATCH /memory/{memory_id}`; absent fields are left alone. Every PATCH resets the\nrecord's age -- `updated_at` moves to now, so decay starts over.\n\nA PATCH changes what is said *about* a record, in place: its labels, its confidence, and a\ncommitment's status, due time and person owed. What the record itself says is changed by\nwriting its successor (`POST /memory` with `supersedes`), never here, so the old wording\nstays in the record's history.", "properties": { "confidence": { "anyOf": [ { "maximum": 1.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "Replacement confidence", "title": "Confidence" }, "due_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "A commitment's new due time; only for type 'commitment'", "title": "Due At" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "labels the rules over this row's kind read, as label -> a value or a list of 1 to 32 distinct values, each of 1 to 256 characters; at most 32 names. Held to the organisation's vocabulary and, for a request naming a person, to `writable_labels`; replaces the record's labels whole", "title": "Labels" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "maxProperties": 16, "type": "object" }, { "type": "null" } ], "description": "Replacement metadata", "title": "Metadata" }, "owed_to": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Who a commitment is now owed to; only for type 'commitment'", "title": "Owed To" }, "status": { "anyOf": [ { "enum": [ "open", "fulfilled", "cancelled" ], "type": "string" }, { "type": "null" } ], "description": "A commitment's new status; only for type 'commitment'", "title": "Status" } }, "title": "MemoryUpdate", "type": "object" }, "MessageCounts": { "description": "How many `message` items a thread holds, by who wrote them. A tool call, its result, a\nreasoning block and a refusal are how a turn worked, not what was said, and count under none\nof the three (`docs/architecture/threads.md`).", "properties": { "assistant": { "description": "messages a model wrote", "title": "Assistant", "type": "integer" }, "developer": { "description": "messages the developer wrote, such as a notice", "title": "Developer", "type": "integer" }, "user": { "description": "messages the person (or a delegate) wrote", "title": "User", "type": "integer" } }, "required": [ "user", "assistant", "developer" ], "title": "MessageCounts", "type": "object" }, "MessageIn": { "additionalProperties": false, "description": "One entry of the request's `messages`.", "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "discriminator": { "mapping": { "document": "#/components/schemas/DocumentBlockIn", "image": "#/components/schemas/ImageBlockIn", "text": "#/components/schemas/TextBlockIn", "thinking": "#/components/schemas/ThinkingBlockIn", "tool_result": "#/components/schemas/ToolResultBlockIn", "tool_use": "#/components/schemas/ToolUseBlockIn" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/TextBlockIn" }, { "$ref": "#/components/schemas/ImageBlockIn" }, { "$ref": "#/components/schemas/DocumentBlockIn" }, { "$ref": "#/components/schemas/ToolUseBlockIn" }, { "$ref": "#/components/schemas/ToolResultBlockIn" }, { "$ref": "#/components/schemas/ThinkingBlockIn" } ] }, "type": "array" } ], "description": "the message's content: a string, or content blocks", "title": "Content" }, "role": { "description": "who is speaking; `system` is an instruction a client places inside `messages` at its own position, text blocks only", "enum": [ "user", "assistant", "system" ], "title": "Role", "type": "string" } }, "required": [ "role", "content" ], "title": "MessageIn", "type": "object" }, "MessageInput": { "additionalProperties": false, "description": "One message in the request's `input`.", "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "discriminator": { "mapping": { "input_audio": "#/components/schemas/InputAudioPart", "input_file": "#/components/schemas/InputFilePart", "input_image": "#/components/schemas/InputImagePart", "input_text": "#/components/schemas/InputTextPart", "output_text": "#/components/schemas/OutputTextPart", "refusal": "#/components/schemas/RefusalPart" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/InputTextPart" }, { "$ref": "#/components/schemas/OutputTextPart" }, { "$ref": "#/components/schemas/RefusalPart" }, { "$ref": "#/components/schemas/InputImagePart" }, { "$ref": "#/components/schemas/InputFilePart" }, { "$ref": "#/components/schemas/InputAudioPart" } ] }, "type": "array" } ], "description": "the message's content", "title": "Content" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the item's id; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Id" }, "phase": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the message's phase; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Phase" }, "role": { "description": "who is speaking; system maps to the developer authority", "enum": [ "user", "developer", "system", "delegate", "assistant" ], "title": "Role", "type": "string" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the item's status; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Status" }, "type": { "const": "message", "default": "message", "description": "input item kind", "title": "Type", "type": "string" } }, "required": [ "role", "content" ], "title": "MessageInput", "type": "object" }, "MessageObject": { "additionalProperties": false, "description": "Anthropic's `message`: what `POST /messages` answers, and nothing more.", "properties": { "container": { "description": "always null: the vendor's code-execution container, which Core does not run", "title": "Container", "type": "null" }, "content": { "description": "what the model produced, in order", "items": { "discriminator": { "mapping": { "mcp_tool_result": "#/components/schemas/MCPToolResultBlock", "mcp_tool_use": "#/components/schemas/MCPToolUseBlock", "text": "#/components/schemas/TextBlock", "thinking": "#/components/schemas/ThinkingBlock", "tool_use": "#/components/schemas/ToolUseBlock" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/TextBlock" }, { "$ref": "#/components/schemas/ThinkingBlock" }, { "$ref": "#/components/schemas/ToolUseBlock" }, { "$ref": "#/components/schemas/MCPToolUseBlock" }, { "$ref": "#/components/schemas/MCPToolResultBlock" } ] }, "title": "Content", "type": "array" }, "id": { "description": "the message's id. Core's own `resp_` id, so the same value works as `previous_response_id`, on `GET /responses/{id}` and on `GET /artifacts?response_id=`", "title": "Id", "type": "string" }, "model": { "description": "the model that actually answered this turn's last round", "title": "Model", "type": "string" }, "role": { "const": "assistant", "default": "assistant", "description": "always assistant", "title": "Role", "type": "string" }, "stop_details": { "anyOf": [ { "$ref": "#/components/schemas/RefusalStopDetails" }, { "type": "null" } ], "description": "structured information about a refusal, else null" }, "stop_reason": { "anyOf": [ { "enum": [ "end_turn", "max_tokens", "stop_sequence", "tool_use", "pause_turn", "refusal" ], "type": "string" }, { "type": "null" } ], "description": "why the turn stopped", "title": "Stop Reason" }, "stop_sequence": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "always null: Core honours `stop_sequences`, but no provider port says which one ended the turn", "title": "Stop Sequence" }, "type": { "const": "message", "default": "message", "description": "the object's wire type", "title": "Type", "type": "string" }, "usage": { "$ref": "#/components/schemas/MessageUsage", "description": "token usage for this turn" } }, "required": [ "id", "model", "content", "stop_reason", "usage" ], "title": "MessageObject", "type": "object" }, "MessageOutput": { "additionalProperties": false, "description": "A message item, as the Responses API renders one.", "properties": { "content": { "description": "the message's content parts", "items": { "discriminator": { "mapping": { "input_file": "#/components/schemas/InputFileContent", "input_image": "#/components/schemas/InputImageContent", "input_text": "#/components/schemas/InputTextContent", "output_text": "#/components/schemas/OutputTextContent", "refusal": "#/components/schemas/RefusalContent" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/OutputTextContent" }, { "$ref": "#/components/schemas/InputTextContent" }, { "$ref": "#/components/schemas/RefusalContent" }, { "$ref": "#/components/schemas/InputImageContent" }, { "$ref": "#/components/schemas/InputFileContent" } ] }, "title": "Content", "type": "array" }, "id": { "description": "the item's id", "title": "Id", "type": "string" }, "role": { "description": "who authored this message -- the Responses API's own set. Core's `delegate` tier renders as `user`, because a delegate speaks for a person and no vendor has a word for the tier itself; its `core` tier renders as nothing at all, because Core's own scaffolding is context Core added rather than an item a caller is shown. `system` is upstream's and is accepted back as input, but Core maps an incoming `system` message onto the developer tier, so nothing it answers ever says it", "enum": [ "assistant", "developer", "system", "user" ], "title": "Role", "type": "string" }, "status": { "default": "completed", "description": "the item's completion status: `incomplete` for a model's message whose text stops where its model call was cut -- a cancel, shutdown, the turn's deadline or a provider that failed partway -- and `completed` for every other", "enum": [ "completed", "incomplete" ], "title": "Status", "type": "string" }, "type": { "const": "message", "default": "message", "description": "output item kind", "title": "Type", "type": "string" } }, "required": [ "id", "role", "content" ], "title": "MessageOutput", "type": "object" }, "MessageUsage": { "additionalProperties": false, "description": "Token usage for one turn, in the vendor's own shape.", "properties": { "cache_creation": { "description": "always null: the vendor's breakdown by cache lifetime, of a cache Core asks for no entry in on this surface", "title": "Cache Creation", "type": "null" }, "cache_creation_input_tokens": { "default": 0, "description": "always 0: Core takes no prompt-cache instruction on this surface", "title": "Cache Creation Input Tokens", "type": "integer" }, "cache_read_input_tokens": { "default": 0, "description": "always 0: Core takes no prompt-cache instruction on this surface", "title": "Cache Read Input Tokens", "type": "integer" }, "inference_geo": { "description": "always null: where a turn was allowed to run is Core's own region vocabulary, decided per key and recorded on the turn's policy decision, and the vendor's geographies are not that vocabulary (`docs/architecture/data-residency.md`)", "title": "Inference Geo", "type": "null" }, "input_tokens": { "description": "tokens consumed by context sent to the model", "title": "Input Tokens", "type": "integer" }, "output_tokens": { "description": "tokens the model generated", "title": "Output Tokens", "type": "integer" }, "output_tokens_details": { "description": "always null: the vendor's split of the generated tokens, which Core's own metering does not receive from every provider it calls and therefore never half-reports", "title": "Output Tokens Details", "type": "null" }, "server_tool_use": { "description": "always null: the vendor counts its own server tools here, and Core runs none of them", "title": "Server Tool Use", "type": "null" }, "service_tier": { "description": "always null: Core has one tier and refuses `service_tier`", "title": "Service Tier", "type": "null" } }, "required": [ "input_tokens", "output_tokens" ], "title": "MessageUsage", "type": "object" }, "MessagesRequest": { "additionalProperties": false, "description": "Anthropic's `POST /v1/messages` body, plus Core's own extensions.", "properties": { "agent": { "anyOf": [ { "$ref": "#/components/schemas/AgentRef" }, { "type": "null" } ], "description": "a stored agent this turn is built on (Core extension). Required under a key whose policy sets `settings.agents_required`: a turn naming none, or adding `system`, `tools` or `skills` of its own, is refused with 403" }, "background": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "refused by Core: a `message` object has no state to poll, and this surface has no GET -- POST /responses runs a background turn", "title": "Background" }, "betas": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "the vendor's beta feature flags; accepted and ignored: a hint that does not change what the answer means, so it is neither refused nor forwarded, stored or echoed", "title": "Betas" }, "cache_control": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the vendor's top-level prompt-cache hint; accepted and ignored: a hint that does not change what the answer means, so it is neither refused nor forwarded, stored or echoed", "title": "Cache Control" }, "callback_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "refused by Core: it only means anything for a background run", "title": "Callback Url" }, "container": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "string" }, { "type": "null" } ], "description": "refused by Core", "title": "Container" }, "context_management": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the vendor's server-side context editing; accepted and ignored: a hint that does not change what the answer means, so it is neither refused nor forwarded, stored or echoed (Core edits no context and its answer means the same without)", "title": "Context Management" }, "fallbacks": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "string" }, { "type": "null" } ], "description": "refused by Core", "title": "Fallbacks" }, "hosting": { "anyOf": [ { "$ref": "#/components/schemas/HostingRequirement" }, { "type": "null" } ], "description": "where the model answering this turn must run (Core)" }, "inference_geo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "refused by Core", "title": "Inference Geo" }, "max_tokens": { "description": "ceiling on generated output tokens", "minimum": 1.0, "title": "Max Tokens", "type": "integer" }, "max_tool_rounds": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "ceiling on tool rounds for this turn (Core)", "title": "Max Tool Rounds" }, "mcp_servers": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "refused by Core", "title": "Mcp Servers" }, "messages": { "default": [], "description": "the conversation so far", "items": { "$ref": "#/components/schemas/MessageIn" }, "maxItems": 1024, "title": "Messages", "type": "array" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/MetadataIn" }, { "type": "null" } ], "description": "who this turn is for", "x-core-subject-alias": true }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "catalogue model id to run this turn against, or an agent to build it on: `agent:` or the agent's `agt_` id, as `GET /models` lists them, which makes `system` the caller's own instruction ahead of the agent's. Optional only when `agent` names an agent version that fixes one", "title": "Model" }, "output_config": { "anyOf": [ { "$ref": "#/components/schemas/OutputConfigIn" }, { "type": "null" } ], "description": "effort and output format" }, "previous_response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "continue the thread that produced this response (Core)", "title": "Previous Response Id" }, "service_tier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the vendor's capacity tier; accepted and ignored: a hint that does not change what the answer means, so it is neither refused nor forwarded, stored or echoed", "title": "Service Tier" }, "skills": { "default": [], "description": "skill names or ids to offer (Core)", "items": { "type": "string" }, "maxItems": 32, "title": "Skills", "type": "array" }, "speed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "refused by Core", "title": "Speed" }, "stop_sequences": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "sequences that end the answer where the model would write one. Refused with a 400 naming it on a model whose provider has no such parameter (OpenAI's Responses API). The answer does not yet say which sequence ended it: `stop_reason` is `end_turn` and `stop_sequence` null", "title": "Stop Sequences" }, "store": { "default": true, "description": "persist this turn when threads are effective", "title": "Store", "type": "boolean" }, "stream": { "default": false, "description": "answer Server-Sent Events as it happens", "title": "Stream", "type": "boolean" }, "system": { "anyOf": [ { "type": "string" }, { "items": { "$ref": "#/components/schemas/TextBlockIn" }, "type": "array" }, { "type": "null" } ], "description": "the standing system prompt", "title": "System" }, "temperature": { "anyOf": [ { "maximum": 2.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "sampling temperature", "title": "Temperature" }, "thinking": { "anyOf": [ { "$ref": "#/components/schemas/ThinkingIn" }, { "type": "null" } ], "description": "what this turn asks of the model's own thinking" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "continue this thread (Core)", "title": "Thread Id" }, "tool_choice": { "anyOf": [ { "$ref": "#/components/schemas/ToolChoiceIn" }, { "type": "null" } ], "description": "how the model may use the offered tools" }, "tool_search": { "anyOf": [ { "$ref": "#/components/schemas/ToolSearchParam" }, { "type": "null" } ], "description": "whether this turn offers its server tools directly or behind the tool router (Core): `router` needs the key's `tooling.tool_search.enabled` and wins over the agent's own choice; null takes the agent's, then the key's default" }, "tool_variables": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Values for the call variables the tools of this turn declare, as a flat object of names to strings, numbers or booleans. Never shown to the model and never echoed: each tool receives only the variables it declares, checked against its declaration before the model is called (422 on tool_variables., naming the tool); a name no tool declares is ignored. A nested agent, a subagent and a task inherit them. At most `tool_variables_max_names` names, `tool_variables_max_string_chars` characters in one string and `tool_variables_max_bytes` bytes in all (Core)", "propertyNames": { "maxLength": 64, "minLength": 1 }, "title": "Tool Variables", "type": "object" }, "tools": { "default": [], "description": "tools offered this turn", "items": { "discriminator": { "mapping": { "core_tool": "#/components/schemas/CoreToolIn", "core_toolset": "#/components/schemas/CoreToolsetIn", "custom": "#/components/schemas/CustomToolIn", "tool_search_tool_bm25": "#/components/schemas/ToolSearchToolIn", "tool_search_tool_bm25_20251119": "#/components/schemas/ToolSearchToolIn", "tool_search_tool_regex": "#/components/schemas/ToolSearchToolIn", "tool_search_tool_regex_20251119": "#/components/schemas/ToolSearchToolIn", "web_search_20250305": "#/components/schemas/WebSearchServerToolIn", "web_search_20260209": "#/components/schemas/WebSearchServerToolIn", "web_search_20260318": "#/components/schemas/WebSearchServerToolIn" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CustomToolIn" }, { "$ref": "#/components/schemas/CoreToolIn" }, { "$ref": "#/components/schemas/CoreToolsetIn" }, { "$ref": "#/components/schemas/WebSearchServerToolIn" }, { "$ref": "#/components/schemas/ToolSearchToolIn" } ] }, "maxItems": 128, "title": "Tools", "type": "array" }, "top_k": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "description": "sample from the K likeliest tokens only. Refused with a 400 naming it on a model whose provider has no such parameter (the OpenAI family), or that the operator declared without `temperature`", "title": "Top K" }, "top_p": { "anyOf": [ { "maximum": 1.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "nucleus sampling: the probability mass the model samples from. Refused with a 400 naming it on a model the operator declared without `temperature`", "title": "Top P" } }, "required": [ "max_tokens" ], "title": "MessagesRequest", "type": "object" }, "MetadataIn": { "description": "Anthropic's `metadata`: `user_id` says who the turn was for; every other key is a\nclient's own label, accepted and ignored (`extra=\"ignore\"` drops it on parse, so it is never\nstored or echoed).\n\n`user_id` is held to a length here and to nothing else: whether a value that does not fit a\nsubject id is ignored or refused depends on the calling key, which a wire model cannot know,\nso the route decides it (`app.messages.router.person_named`) and `translate_request` is\nhanded the answer.", "properties": { "user_id": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "the calling application's own opaque identifier of the person this turn is for; a value that fits a subject id becomes Core's `user`, which a tool authenticating as that person resolves its stored grant by. A value that does not fit one -- a coding agent's own session identifier -- is ignored on a key that does not hold `subjects` and refused on a key that does; at most 1024 characters either way", "title": "User Id" } }, "title": "MetadataIn", "type": "object" }, "ModelCallDocumentRead": { "description": "One traced model call and the document behind it: what went, what came back, and Core's\nown reading of the same call.", "properties": { "call": { "$ref": "#/components/schemas/ModelCallRead", "description": "The call this document belongs to" }, "document": { "$ref": "#/components/schemas/TraceDocument", "description": "The three sections of the call: the request the provider received, its answer, and Core's reading of the context, the tools and the routing" }, "object": { "const": "model_call_document", "default": "model_call_document", "description": "The object's type", "title": "Object", "type": "string" } }, "required": [ "call", "document" ], "title": "ModelCallDocumentRead", "type": "object" }, "ModelCallRead": { "description": "One traced model call, as a list answers it: everything but the document.", "properties": { "created_at": { "description": "When this record was written", "format": "date-time", "title": "Created At", "type": "string" }, "document_bytes": { "description": "How large this call's stored document is, in bytes", "title": "Document Bytes", "type": "integer" }, "draft": { "default": false, "description": "Whether a run of a draft or a console try made this call: such a call is read on the management twin alone", "title": "Draft", "type": "boolean" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why it failed, as a fixed code and never a provider's own words; null when it did not fail", "title": "Error Code" }, "finished_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the call ended, however it ended", "title": "Finished At" }, "first_byte_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the first byte of the answer arrived; null when none did", "title": "First Byte At" }, "id": { "description": "Model call id", "title": "Id", "type": "string" }, "job": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The work behind this call when it was not a response's own round, as `{kind, id}`: an ingest run, an evaluation run, a compaction. Null for a call a response's own turn loop made. A compaction's summarise call carries a job and, when it was made for a turn, that turn's `response_id` as well; it also carries `block` (the block it made and the summary id it minted) and `run` (the planning it was made under), which the conversation twin reads its compaction runs from", "title": "Job" }, "kind": { "description": "What asked for this call: chat, embedding, image, summary, judge or pipeline", "enum": [ "chat", "embedding", "image", "summary", "judge", "pipeline", "analysis", "helper", "transcription", "speech", "decision" ], "title": "Kind", "type": "string" }, "model_answered": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The model that actually answered, which differs from the requested one after a fallover; null when none answered", "title": "Model Answered" }, "model_requested": { "description": "The model Core asked for", "title": "Model Requested", "type": "string" }, "object": { "const": "model_call", "default": "model_call", "description": "The object's type", "title": "Object", "type": "string" }, "provider_kind": { "description": "The provider family that answered this call", "title": "Provider Kind", "type": "string" }, "request_id": { "description": "Id of the request or job run behind this call", "title": "Request Id", "type": "string" }, "response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The response whose turn made this call; null for a call no response asked for -- a compaction summary, an ingest run's node, an evaluation judge", "title": "Response Id" }, "round": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Which round of the turn this call is, counted from zero; null for a call no turn loop made", "title": "Round" }, "span_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Span this call happened in, when telemetry was recording", "title": "Span Id" }, "started_at": { "description": "When Core began this call", "format": "date-time", "title": "Started At", "type": "string" }, "status": { "description": "How the call ended: ok, error or cancelled", "enum": [ "ok", "error", "cancelled" ], "title": "Status", "type": "string" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this call was made for, as the calling application named them; null for a call made for nobody in particular", "title": "Subject" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The thread the turn behind this call ran on; null when it ran on none", "title": "Thread Id" }, "tool_calls": { "description": "The tool executions this call's answer asked for, oldest first; empty for a call whose answer asked for none", "items": { "$ref": "#/components/schemas/ToolCallRead" }, "title": "Tool Calls", "type": "array" }, "trace_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Trace this call happened in, when telemetry was recording", "title": "Trace Id" }, "truncated": { "description": "Whether the request or response section was cut to fit the document cap; Core's own reading of the call is never cut", "title": "Truncated", "type": "boolean" }, "usage": { "additionalProperties": true, "description": "Token usage as the vendor reported it; empty when it reported none", "title": "Usage", "type": "object" } }, "required": [ "id", "response_id", "thread_id", "kind", "job", "provider_kind", "model_requested", "model_answered", "status", "error_code", "started_at", "first_byte_at", "finished_at", "usage", "document_bytes", "truncated", "request_id", "trace_id", "span_id", "created_at", "tool_calls" ], "title": "ModelCallRead", "type": "object" }, "ModelDeprecationRead": { "description": "That a model is being retired, as both catalogue listings say it (a Core extension): what\na console renders as \"works until , then \".", "properties": { "effective_date": { "description": "the day, in UTC, from whose start a turn naming this model no longer runs on it: it is rerouted to `replacement`, or refused where the organisation's or the key's policy settings say `deprecated_models: block`", "format": "date", "title": "Effective Date", "type": "string" }, "in_effect": { "description": "whether `effective_date` has begun, at the instant this listing was read", "title": "In Effect", "type": "boolean" }, "replacement": { "description": "catalogue id of the model that takes this one's place", "title": "Replacement", "type": "string" } }, "required": [ "effective_date", "replacement", "in_effect" ], "title": "ModelDeprecationRead", "type": "object" }, "ModelList": { "description": "`GET /models`: Core's own `{items, next_cursor}` page, and beside it the `{object, data,\nhas_more, first_id, last_id}` list the OpenAI and Anthropic SDKs read, additively.", "properties": { "data": { "description": "every chat model this key may target, whole and unpaged, for the vendors' SDKs, which read this field and one page of it; empty when `kind` is not chat", "items": { "$ref": "#/components/schemas/ModelListEntry" }, "title": "Data", "type": "array" }, "first_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "`id` of the first entry of `data`; null when `data` is empty", "title": "First Id" }, "has_more": { "default": false, "description": "always false: `data` is the whole list, so an SDK never asks for a next page", "title": "Has More", "type": "boolean" }, "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ModelRead" }, "title": "Items", "type": "array" }, "last_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "`id` of the last entry of `data`; null when `data` is empty", "title": "Last Id" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" }, "object": { "const": "list", "default": "list", "description": "the object's wire type, OpenAI's name", "title": "Object", "type": "string" } }, "required": [ "items", "data" ], "title": "ModelList", "type": "object" }, "ModelListEntry": { "description": "One chat model as the vendors' SDKs read a model list: the fields both the OpenAI and the\nAnthropic model objects require, in one object. Not `ModelRead`: that one is Core's own, with\nwhere the model runs and what it costs, and is what `items` carries.", "properties": { "created": { "default": 0, "description": "Unix time the model was created, as OpenAI's SDK reads it; always 0, because Core's catalogue records no creation time", "title": "Created", "type": "integer" }, "created_at": { "default": "1970-01-01T00:00:00Z", "description": "RFC 3339 time the model was created, as Anthropic's SDK reads it; always the Unix epoch, because Core's catalogue records no creation time", "format": "date-time", "title": "Created At", "type": "string" }, "display_name": { "description": "human name of the model; the catalogue has no separate one, so its id", "title": "Display Name", "type": "string" }, "id": { "description": "catalogue model id callers pass as `model`, a router's id, or an agent's selector (`agent:`)", "title": "Id", "type": "string" }, "object": { "const": "model", "default": "model", "description": "the object's wire type, OpenAI's name", "title": "Object", "type": "string" }, "owned_by": { "description": "name of the provider that offers this model", "title": "Owned By", "type": "string" }, "type": { "const": "model", "default": "model", "description": "the object's wire type, Anthropic's name", "title": "Type", "type": "string" } }, "required": [ "id", "owned_by", "display_name" ], "title": "ModelListEntry", "type": "object" }, "ModelPriceRead": { "description": "What one catalogue model costs the asking organisation right now, as `GET /models` and\n`GET /tenants/{tenant_id}/models` carry it (a Core extension on both).\n\nOne read model for both surfaces, resolved through the same authority the usage summary is\ncosted by (`app.audit.prices`), at \"now\": a key and the person administering its organisation\nmust never be shown two different prices for one model.", "properties": { "cache_write_eur_per_million_tokens": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Price of one million input tokens written to the provider's cache in euro, as an exact decimal string; never rounded here; null when a written token is charged exactly like an uncached one", "title": "Cache Write Eur Per Million Tokens" }, "cached_input_eur_per_million_tokens": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Price of one million cache-served input tokens in euro, as an exact decimal string; never rounded here; null when a cached token is charged exactly like an uncached one", "title": "Cached Input Eur Per Million Tokens" }, "effective_from": { "description": "Instant this price came into force", "format": "date-time", "title": "Effective From", "type": "string" }, "eur_per_unit": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Price of one generated image, one minute of transcribed audio for an audio model, or one million characters spoken for a speech model, in euro, as an exact decimal string; never rounded here; null for a model priced per million tokens", "title": "Eur Per Unit" }, "exchange_rate": { "anyOf": [ { "$ref": "#/components/schemas/AppliedRateRead" }, { "type": "null" } ], "description": "The rate the euro amounts were converted by -- the newest stored ECB rate, since a catalogue is read in an open month; null for a price listed in euro" }, "input_eur_per_million_tokens": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Price of one million input tokens in euro, as an exact decimal string; never rounded here; null for a model priced per unit, such as an image model", "title": "Input Eur Per Million Tokens" }, "is_tenant_override": { "description": "Whether this is the organisation's own price rather than the deployment's", "title": "Is Tenant Override", "type": "boolean" }, "listed": { "$ref": "#/components/schemas/ListedPriceRead", "description": "The same price in the currency the price list holds it in, before the rate" }, "output_eur_per_million_tokens": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Price of one million output tokens in euro, as an exact decimal string; never rounded here; null when the model meters none, or is priced per unit", "title": "Output Eur Per Million Tokens" } }, "required": [ "input_eur_per_million_tokens", "output_eur_per_million_tokens", "cached_input_eur_per_million_tokens", "cache_write_eur_per_million_tokens", "eur_per_unit", "effective_from", "is_tenant_override", "listed", "exchange_rate" ], "title": "ModelPriceRead", "type": "object" }, "ModelRead": { "description": "One model a turn on the calling key may call: a chat model it targets by id, an image\nmodel offered to it as a tool, an embedding model its knowledge, memory and skills embed\nwith, or a router of its organisation -- each with where it runs, so a caller can see what a\nstrict policy would refuse.", "properties": { "allowed": { "default": true, "description": "whether the calling key's model policy admits this model right now (Core extension): `policy.models` and its hosting regions, decided by the same function a call on the model is refused by, for the person the request names when it names one. For kind chat, which lists only the models the rules let the request see, false is one it sees but may not use as a turn's model. For image, embedding, audio, speech and decision, false means a call on the model is refused -- the image tool answering `Denied by policy.`, retrieval going quiet, a transcription, a speech or a decision call answering 403. True is the model's half only: an image, speak or decide tool is also offered only when the key's `tooling.system_tools` lists generate_image, speak or decide and `policy.tools` allows the tool's name", "title": "Allowed", "type": "boolean" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "country this model's inference runs in as an ISO 3166-1 alpha-2 code, when the operator claims one (Core extension)", "title": "Country" }, "deprecation": { "anyOf": [ { "$ref": "#/components/schemas/ModelDeprecationRead" }, { "type": "null" } ], "description": "set when the operator is retiring this model: the day it stops answering as itself and the model that replaces it (Core extension); null for a model nobody retires, and for a router" }, "fallbacks": { "description": "models a turn on this one falls over to, in order, when it is unavailable (Core extension): the chain the calling key's effective routing configuration declares, already narrowed to what this key's own policy allows. Empty when the key falls over to nothing, or when its configuration has no chain for this model", "items": { "type": "string" }, "title": "Fallbacks", "type": "array" }, "features": { "anyOf": [ { "items": { "enum": [ "text_input", "text_output", "image_input", "image_output", "audio_input", "audio_output", "thinking", "tools", "temperature", "json_schema" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "what this model can do, as the operator declares it, in the platform's vocabulary (Core extension); null when the operator declared nothing, in which case Core refuses no request on capability grounds. A declared model refuses a request asking for a feature it does not list with a 400 before any call -- except json_schema, which Core emulates for a model that does not list it", "title": "Features" }, "id": { "description": "catalogue model id callers pass as `model`, a router's id (`auto-...`), or an agent's selector (`agent:`)", "title": "Id", "type": "string" }, "intelligence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "how capable this model is, 0 to 1, unitless, as the operator asserts it on the platform's scale (Core extension); shown only, nothing Core decides reads it, and null when the operator asserts none", "title": "Intelligence" }, "kind": { "default": "chat", "description": "what this model does (Core extension): chat, a model a request targets by id; image, a model offered to a turn as the builtin tool named in `tool_name`; embedding, a model knowledge, memory and skill retrieval embed with; audio, a model POST /audio/transcriptions names to turn speech into text; speech, a model POST /audio/speech names to speak a text; decision, a model POST /decisions names to choose a label or answer a yes-or-no question; router, an organisation's router, which a request targets by id like a chat model and which chooses one of the models in `router.pool` per turn; agent, a stored agent the key reaches, which a request targets by this id like a chat model and which runs on the model it fixes -- where it runs, what it can do and what it costs are that model's (or that router's), and an agent fixing no model, or one this key may not run, is not listed", "enum": [ "chat", "embedding", "image", "audio", "speech", "decision", "router", "agent" ], "title": "Kind", "type": "string" }, "lab": { "anyOf": [ { "enum": [ "anthropic", "openai", "google", "meta", "mistral", "perplexity", "black_forest", "artific", "zai", "deepseek", "alibaba", "baai", "elevenlabs", "deepgram", "assemblyai", "microsoft" ], "type": "string" }, { "type": "null" } ], "description": "the lab that trained this model, as the operator asserts it (Core extension); null where the provider's kind decides no lab and the operator claims none. Not the same question as `owned_by`, which is the provider serving it, nor as `region`, which is where it runs", "title": "Lab" }, "labels": { "default": {}, "description": "the organisation's classification of this model, as label -> value (Core extension): what the rules over `model` read, written through `PUT /labels/model/{id}` and empty for a model nobody classified", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "max_tools": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "the most tools one turn may offer this model (Core extension): the operator's declaration or the default of the provider's kind, never above Core's own ceiling of 128. A turn offering more is refused on `tools` before any call, naming this model and this number. For a router, the smallest among the members of its pool; null for a model of kind image, embedding or audio, which a turn is not offered tools through", "title": "Max Tools" }, "object": { "const": "model", "default": "model", "description": "the object's wire type", "title": "Object", "type": "string" }, "open_weights": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "whether this model's weights are open, as the operator asserts it (Core extension); null where nobody stated it, which a policy requiring open weights refuses. For a router, true only when every member's are", "title": "Open Weights" }, "owned_by": { "description": "name of the provider that offers this model; `router` for a router, `agent` for an agent", "title": "Owned By", "type": "string" }, "price": { "anyOf": [ { "$ref": "#/components/schemas/ModelPriceRead" }, { "type": "null" } ], "description": "what a turn on this model costs this key's organisation right now (Core extension): the organisation's own price when it has one, the deployment's otherwise, and null when nothing prices this model" }, "region": { "description": "jurisdiction this model's inference runs in, as the operator asserts it (Core extension); what a turn's `hosting.region` is decided against", "enum": [ "eu", "us", "in-cluster", "global" ], "title": "Region", "type": "string" }, "router": { "anyOf": [ { "$ref": "#/components/schemas/RouterListing" }, { "type": "null" } ], "description": "for kind router, its version and the pool narrowed to this key (Core extension); null for every model. A router's region is the smallest place containing every member of that pool, its features what every member declares, and its lab, speed, intelligence and price are null: a turn costs what the chosen model costs" }, "speed": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "how fast this model answers, 0 to 1, unitless, as the operator asserts it on the platform's scale (Core extension); shown only, nothing Core decides reads it, and null when the operator asserts none", "title": "Speed" }, "tool_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the builtin tool this model is offered to a turn as (Core extension): builtin__generate_image__ for kind image, builtin__transcribe_audio__ for kind audio, builtin__speak__ for kind speech, builtin__decide__ for kind decision; null for chat and embedding", "title": "Tool Name" }, "vendor": { "anyOf": [ { "$ref": "#/components/schemas/VendorOrigin" }, { "type": "null" } ], "description": "who runs this model's provider, as the operator asserts it (Core extension): where the company and its ultimate parent are established, in the vocabulary `region` uses, each null where nobody stated it -- which a policy's `vendors_allow` reads as 'global'. Null for a router whose members differ" } }, "required": [ "id", "owned_by", "region", "country", "vendor", "open_weights", "lab", "features", "speed", "intelligence", "max_tools", "price" ], "title": "ModelRead", "type": "object" }, "ModelReferenceRead": { "description": "One place one of the organisation's configurations still names a model, as\n`GET /tenants/{tenant_id}/model-references` and `GET /organisation/model-references` list\nit.", "properties": { "deprecation": { "anyOf": [ { "$ref": "#/components/schemas/ModelDeprecationRead" }, { "type": "null" } ], "description": "the model's deprecation, at the instant this list was read; null when the model asked about is not being retired" }, "field": { "description": "where in the resource the model is named: `model`, `tools` (an image tool of the model), `pool`, `chains`, `capabilities.compaction.model`, `request.model`, `request.tools`, `judge_model` or `embedding_model` -- the last also for an index that names none and so embeds with the deployment's model", "title": "Field", "type": "string" }, "model": { "description": "catalogue id of the model named", "title": "Model", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "that resource's own name, where it has one", "title": "Name" }, "object": { "const": "model_reference", "default": "model_reference", "description": "the object's wire type", "title": "Object", "type": "string" }, "resource": { "description": "what names it: an agent's latest version, a router's latest version, a routing configuration's chains, a key's compaction configuration, a schedule's stored request, an evaluation suite's judge, or a knowledge index's embedding model", "enum": [ "agent", "router", "routing_config", "key", "schedule", "evaluation", "knowledge_index" ], "title": "Resource", "type": "string" }, "resource_id": { "description": "id of the agent, router, key, ... that names it", "title": "Resource Id", "type": "string" } }, "required": [ "model", "resource", "resource_id", "name", "field", "deprecation" ], "title": "ModelReferenceRead", "type": "object" }, "ModelReport": { "additionalProperties": false, "description": "Which models the bundle names, and which of them this deployment cannot serve.", "properties": { "required": { "description": "Catalogue model ids the manifest declares or its members name", "items": { "type": "string" }, "title": "Required", "type": "array" }, "routers_missing": { "description": "Of those, the router ids (`auto-...`) the subscriber has no live router by; advice, not a refusal -- a turn naming one answers as an unknown model would until the subscriber writes a live router of that id", "items": { "type": "string" }, "title": "Routers Missing", "type": "array" }, "unavailable": { "description": "Of those, the ones this deployment's catalogue holds no chat model for; advice, not a refusal -- a turn naming one answers 422 when it runs. A router id is never here: routers are an organisation's own, and `routers_missing` reports them", "items": { "type": "string" }, "title": "Unavailable", "type": "array" } }, "title": "ModelReport", "type": "object" }, "ModelRoleRead": { "description": "One model call Core makes on the calling key's behalf that no request names: the\nsummariser that compacts a thread, or the embedding model retrieval embeds with. Where it\nruns, as `ModelRead` says it for a model a request does name.", "properties": { "allowed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "whether the calling key's policy admits this model right now, decided as the call itself is; null when `model` is null, because the turn's own model is decided with the turn. Refused, a summariser sends the thread's items verbatim and the embedding model costs a turn its retrieval", "title": "Allowed" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "country the model runs in as an ISO 3166-1 alpha-2 code, when the operator claims one", "title": "Country" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "catalogue id of the model this role calls; null for a summariser that uses the turn's own model, which is then placed where that model runs", "title": "Model" }, "object": { "const": "model_role", "default": "model_role", "description": "the object's wire type", "title": "Object", "type": "string" }, "region": { "anyOf": [ { "enum": [ "eu", "us", "in-cluster", "global" ], "type": "string" }, { "type": "null" } ], "description": "jurisdiction the model runs in, as the operator asserts it; null when `model` is null, or when the catalogue no longer holds the model, which a key that names regions is refused on", "title": "Region" }, "role": { "description": "summariser: the model that summarises a thread under this key's compaction configuration; embedding: the deployment's embedding model, which knowledge, memory and skill retrieval embed with unless an index names its own", "enum": [ "summariser", "embedding" ], "title": "Role", "type": "string" } }, "required": [ "role", "model", "region", "country", "allowed" ], "title": "ModelRoleRead", "type": "object" }, "ModelRouterCreate": { "additionalProperties": false, "description": "Body of `POST .../model-routers`: the router and its first version.", "properties": { "default": { "description": "The list used whenever the task type is not trusted, drawn from `pool`", "items": { "maxLength": 200, "pattern": "^[A-Za-z0-9._:/-]{1,200}$", "type": "string" }, "maxItems": 16, "minItems": 1, "title": "Default", "type": "array" }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "description": "Shown in the console; not on `GET /models`", "title": "Description" }, "id": { "description": "What a caller passes as `model`; begins with `auto-`", "pattern": "^auto-[a-z0-9][a-z0-9._-]{0,62}$", "title": "Id", "type": "string" }, "live": { "default": false, "description": "Whether ordinary turns may use it; an evaluation run may use one that is not", "title": "Live", "type": "boolean" }, "low_confidence": { "default": 0.8, "description": "The probability of `low` at or above which a turn is treated as low", "maximum": 1.0, "minimum": 0.0, "title": "Low Confidence", "type": "number" }, "max_output_price": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "A ceiling in euro per million output tokens: a pool member priced above it for this organisation, markups included, or priced by nothing, is dropped at admission. Null is no ceiling", "title": "Max Output Price" }, "momentum": { "default": true, "description": "Whether a turn continuing a high turn stays high until an acknowledgement", "title": "Momentum", "type": "boolean" }, "ood_similarity": { "anyOf": [ { "maximum": 1.0, "minimum": -1.0, "type": "number" }, { "type": "null" } ], "description": "The nearest-example similarity below which a turn is out of distribution and takes `default`; null switches the test off", "title": "Ood Similarity" }, "pool": { "description": "The catalogue chat models the router may choose from, in order, between one and sixteen; each must be a chat model this organisation may use", "items": { "maxLength": 200, "pattern": "^[A-Za-z0-9._:/-]{1,200}$", "type": "string" }, "maxItems": 16, "minItems": 1, "title": "Pool", "type": "array" }, "task_confidence": { "default": 0.7, "description": "The calibrated top-1 probability at or above which the task type is trusted", "maximum": 1.0, "minimum": 0.0, "title": "Task Confidence", "type": "number" }, "tiers": { "additionalProperties": { "$ref": "#/components/schemas/TierLists" }, "description": "Per task type, an ordered list per difficulty, each entry drawn from `pool`; `ack` takes a `low` list only. A task type left out uses `default`", "propertyNames": { "enum": [ "general", "code", "summarisation", "extraction", "reasoning", "data_analysis", "ack" ] }, "title": "Tiers", "type": "object" } }, "required": [ "id", "pool", "default" ], "title": "ModelRouterCreate", "type": "object" }, "ModelRouterRead": { "description": "A router with its latest version, as the management routes and their twins answer it.", "properties": { "created_at": { "description": "When the router was created", "format": "date-time", "title": "Created At", "type": "string" }, "default": { "description": "The list used when the task type is not trusted", "items": { "type": "string" }, "title": "Default", "type": "array" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Shown in the console", "title": "Description" }, "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "id": { "description": "What a caller passes as `model`", "title": "Id", "type": "string" }, "latest_version": { "description": "The highest published version; 0 for a router with only drafts, which is never live", "title": "Latest Version", "type": "integer" }, "live": { "description": "Whether ordinary turns may use it", "title": "Live", "type": "boolean" }, "low_confidence": { "description": "The probability of `low` that makes a turn low", "title": "Low Confidence", "type": "number" }, "max_output_price": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "The ceiling in euro per million output tokens; null is none", "title": "Max Output Price" }, "momentum": { "description": "Whether momentum along a thread is on", "title": "Momentum", "type": "boolean" }, "object": { "const": "model_router", "default": "model_router", "description": "The object's type", "title": "Object", "type": "string" }, "ood_similarity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The out-of-distribution threshold; null when switched off", "title": "Ood Similarity" }, "pool": { "description": "The catalogue chat models it may choose from, in order", "items": { "type": "string" }, "title": "Pool", "type": "array" }, "task_confidence": { "description": "The task type's trust threshold", "title": "Task Confidence", "type": "number" }, "tenant_id": { "description": "Owning organisation id", "title": "Tenant Id", "type": "string" }, "tiers": { "additionalProperties": { "$ref": "#/components/schemas/TierLists" }, "description": "Per task type, a list per difficulty", "propertyNames": { "enum": [ "general", "code", "summarisation", "extraction", "reasoning", "data_analysis", "ack" ] }, "title": "Tiers", "type": "object" }, "updated_at": { "description": "When the router or its table last changed", "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "description": "The version the table fields are: the latest published one, which a live turn is routed by, or, for a router with only drafts, which only the management route reads, its newest draft", "title": "Version", "type": "integer" } }, "required": [ "id", "tenant_id", "description", "live", "version", "latest_version", "pool", "tiers", "default", "max_output_price", "task_confidence", "low_confidence", "ood_similarity", "momentum", "created_at", "updated_at" ], "title": "ModelRouterRead", "type": "object" }, "ModelRouterUpdate": { "additionalProperties": false, "description": "Body of `PATCH .../model-routers/{router_id}`: every field optional and left alone when\nabsent. A change to any field but `live` and `description` writes a new version.", "properties": { "default": { "anyOf": [ { "items": { "maxLength": 200, "pattern": "^[A-Za-z0-9._:/-]{1,200}$", "type": "string" }, "maxItems": 16, "minItems": 1, "type": "array" }, { "type": "null" } ], "description": "Replaces the default list; a new version", "title": "Default" }, "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "description": "Shown in the console; null clears it", "title": "Description" }, "live": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether ordinary turns may use it", "title": "Live" }, "low_confidence": { "anyOf": [ { "maximum": 1.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "Replaces the difficulty threshold; a new version", "title": "Low Confidence" }, "max_output_price": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Replaces the ceiling, null removes it; a new version", "title": "Max Output Price" }, "momentum": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Replaces momentum; a new version", "title": "Momentum" }, "ood_similarity": { "anyOf": [ { "maximum": 1.0, "minimum": -1.0, "type": "number" }, { "type": "null" } ], "description": "Replaces the out-of-distribution threshold, null switches it off; a new version", "title": "Ood Similarity" }, "pool": { "anyOf": [ { "items": { "maxLength": 200, "pattern": "^[A-Za-z0-9._:/-]{1,200}$", "type": "string" }, "maxItems": 16, "minItems": 1, "type": "array" }, { "type": "null" } ], "description": "Replaces the pool; a new version", "title": "Pool" }, "task_confidence": { "anyOf": [ { "maximum": 1.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "Replaces the task threshold; a new version", "title": "Task Confidence" }, "tiers": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/TierLists" }, "propertyNames": { "enum": [ "general", "code", "summarisation", "extraction", "reasoning", "data_analysis", "ack" ] }, "type": "object" }, { "type": "null" } ], "description": "Replaces every task type's lists; a new version", "title": "Tiers" } }, "title": "ModelRouterUpdate", "type": "object" }, "ModelRouterVersionRead": { "description": "One immutable version of a router: its table.", "properties": { "created_at": { "description": "When this version was written", "format": "date-time", "title": "Created At", "type": "string" }, "default": { "description": "The list used when the task type is not trusted", "items": { "type": "string" }, "title": "Default", "type": "array" }, "low_confidence": { "description": "The probability of `low` that makes a turn low", "title": "Low Confidence", "type": "number" }, "max_output_price": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Euro per million output tokens above which a pool member is dropped", "title": "Max Output Price" }, "momentum": { "description": "Whether momentum along a thread is on", "title": "Momentum", "type": "boolean" }, "object": { "const": "model_router_version", "default": "model_router_version", "description": "The object's type", "title": "Object", "type": "string" }, "ood_similarity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The out-of-distribution threshold; null when the test is off", "title": "Ood Similarity" }, "pool": { "description": "The catalogue chat models it may choose from, in order", "items": { "type": "string" }, "title": "Pool", "type": "array" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "router_id": { "description": "The router this is a version of", "title": "Router Id", "type": "string" }, "state": { "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "task_confidence": { "description": "The task type's trust threshold", "title": "Task Confidence", "type": "number" }, "tiers": { "additionalProperties": { "$ref": "#/components/schemas/TierLists" }, "description": "Per task type, a list per difficulty", "propertyNames": { "enum": [ "general", "code", "summarisation", "extraction", "reasoning", "data_analysis", "ack" ] }, "title": "Tiers", "type": "object" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" } }, "required": [ "router_id", "version", "state", "pool", "tiers", "default", "max_output_price", "task_confidence", "low_confidence", "ood_similarity", "momentum", "created_at" ], "title": "ModelRouterVersionRead", "type": "object" }, "NameReport": { "additionalProperties": false, "description": "Which member names something of this organisation's already answers to.", "properties": { "collisions": { "description": "Member names whose installed name is already taken by a row that is not this bundle's copy; the sync would refuse each of them", "items": { "type": "string" }, "title": "Collisions", "type": "array" } }, "title": "NameReport", "type": "object" }, "NamespaceFunctionParam": { "additionalProperties": false, "description": "A function tool inside a `namespace`, as the vendor declares one there.", "properties": { "allowed_callers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "the contexts that may call the tool; accepted and ignored: a hint that does not change what the answer means, so Core never forwards it, stores it or answers it back", "title": "Allowed Callers" }, "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "the vendor's tool-search hint: `true` on any entry of a request puts the whole call behind the tool router, as `tool_search` `router` would, never this tool alone; Core's own `tool_search` wins over it", "title": "Defer Loading" }, "description": { "anyOf": [ { "maxLength": 16384, "type": "string" }, { "type": "null" } ], "description": "the tool's description, at most 16384 characters", "title": "Description" }, "name": { "description": "the tool's name inside its namespace", "title": "Name", "type": "string" }, "output_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "a schema of the tool's string output; accepted and ignored: a hint that does not change what the answer means, so Core never forwards it, stores it or answers it back", "title": "Output Schema" }, "parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "JSON Schema for the tool's arguments; none takes none", "title": "Parameters" }, "strict": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "require the model to follow parameters exactly", "title": "Strict" }, "type": { "const": "function", "default": "function", "description": "tool kind", "title": "Type", "type": "string" } }, "required": [ "name" ], "title": "NamespaceFunctionParam", "type": "object" }, "NamespaceToolEcho": { "additionalProperties": false, "description": "A `namespace` the request offered, as it was accepted: its tools under their own names.", "properties": { "description": { "description": "what the namespace holds", "title": "Description", "type": "string" }, "name": { "description": "the namespace", "title": "Name", "type": "string" }, "tools": { "description": "the tools in the namespace", "items": { "discriminator": { "mapping": { "custom": "#/components/schemas/CustomToolEcho", "function": "#/components/schemas/FunctionToolEcho" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/FunctionToolEcho" }, { "$ref": "#/components/schemas/CustomToolEcho" } ] }, "title": "Tools", "type": "array" }, "type": { "const": "namespace", "default": "namespace", "description": "tool kind", "title": "Type", "type": "string" } }, "required": [ "name", "description", "tools" ], "title": "NamespaceToolEcho", "type": "object" }, "NamespaceToolParam": { "additionalProperties": false, "description": "Function and custom tools the caller runs, grouped under one name (`{\"type\": \"namespace\"}`),\nas Codex groups each MCP server's tools.\n\nFlattened for the model: each tool is offered as `ns___`\n(`app.tools.names.namespaced_tool_name`), which no source Core runs can claim, and its call is\nanswered back under its own `name` beside the `namespace`, so the caller routes it. Tool policy\nsees the flattened name -- the names of rules over `tool`, audit subjects, usage rows\n(`docs/architecture/tooling.md`, \"Client tools vs server tools\"). A flattened name past 64\ncharacters, or one another entry already offers, is refused on its own entry, never cut.", "properties": { "description": { "default": "", "description": "what the namespace holds, at most 16384 characters; added in front of each of its tools' own description for the model", "maxLength": 16384, "title": "Description", "type": "string" }, "name": { "description": "the namespace, as the model's calls name it back: letters, digits, `_` and `-`, not beginning with `_`", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "Name", "type": "string" }, "tools": { "description": "the tools in the namespace, at least one and at most 128; each counts toward the turn's tool ceiling on its own", "items": { "discriminator": { "mapping": { "custom": "#/components/schemas/CustomToolParam", "function": "#/components/schemas/NamespaceFunctionParam" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/NamespaceFunctionParam" }, { "$ref": "#/components/schemas/CustomToolParam" } ] }, "maxItems": 128, "minItems": 1, "title": "Tools", "type": "array" }, "type": { "const": "namespace", "default": "namespace", "description": "tool param kind", "title": "Type", "type": "string" } }, "required": [ "name", "tools" ], "title": "NamespaceToolParam", "type": "object" }, "NoAuth": { "additionalProperties": false, "description": "No credential: the source is reached unauthenticated, and any secret already stored on the\nregistration is cleared.", "properties": { "type": { "const": "none", "default": "none", "description": "authentication kind", "title": "Type", "type": "string" } }, "title": "NoAuth", "type": "object" }, "NobodyNamed": { "additionalProperties": false, "description": "Holds when the request names no person: the only atom that can hold without one.", "properties": { "atom": { "const": "nobody_named", "default": "nobody_named", "description": "holds when the request names no person", "title": "Atom", "type": "string" } }, "title": "NobodyNamed", "type": "object" }, "NodeConfig": { "additionalProperties": false, "properties": { "config": { "additionalProperties": true, "description": "the component's parameters", "title": "Config", "type": "object" }, "id": { "description": "node id, unique within the pipeline", "pattern": "^[A-Za-z0-9_-]{1,64}$", "title": "Id", "type": "string" }, "type": { "description": "component type from the registry", "pattern": "^[A-Za-z0-9_-]{1,64}$", "title": "Type", "type": "string" } }, "required": [ "id", "type" ], "title": "NodeConfig", "type": "object" }, "OAuthAuthorizationCodeAuth": { "additionalProperties": false, "description": "A person's own login: OAuth 2.0 authorization code with PKCE, one grant per\n`(source, end user)` (decision 5, `docs/engineering/briefs/tool-sources-2026-09-15/design.md`).\n\nUnlike every other kind, this one holds no credential that can authenticate a call by itself.\nWhat it holds is how to *ask* a person: Core builds an authorization URL against\n`authorize_url`, the person's own browser opens it, the provider redirects to Core's public\ncallback, and Core exchanges the code at `token_url` for a grant it stores per person\n(`app.tools.source_grants`). A turn then sends that person's access token as\n`Authorization: Bearer ...`, and a turn naming no person, or one whose person has no grant, is\nanswered with a fixed sentence rather than a call.\n\n`client_secret` is optional because a public client has none; PKCE S256 is used either way, so\na confidential client's secret is an addition to the proof and never the whole of it.\n\n**Two ways to say which application asks, and exactly one per registration.** Either the\nregistration carries the application itself -- `authorize_url`, `token_url`, `client_id` and\noptionally `client_secret`, the tenant's own OAuth app -- or it names one of the\ndeployment's, `{\"type\": \"oauth_authorization_code\", \"client\": \"github\"}`, and Core resolves\nthe name against `Settings.oauth_clients` at the moment it builds an authorization URL or\nexchanges a code (`resolve_client`, `docs/architecture/connect.md`). The named form is what\nan Artific Connect bundle carries, because the Artific application at a vendor is the\ndeployment's credential and no tenant row may hold it; it is also the only form that can\ntravel in a manifest, since a name is not a secret.", "properties": { "audience": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "Audience sent with the authorization request, for a provider that requires one; null omits the parameter, or takes the named deployment application's", "title": "Audience" }, "authorize_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https?://", "type": "string" }, { "type": "null" } ], "description": "http(s) endpoint the person's own browser is sent to; a literal url, never a template. Core never dials it -- only the person's browser does. Omitted when `client` names a deployment application", "title": "Authorize Url" }, "client": { "anyOf": [ { "maxLength": 32, "pattern": "^[a-z0-9_-]{1,32}$", "type": "string" }, { "type": "null" } ], "description": "Name of one of the deployment's own OAuth applications (`Settings.oauth_clients`), used instead of the four fields below; exclusive with them and with each other, and the only form a shared bundle may carry", "title": "Client" }, "client_id": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "type": "null" } ], "description": "OAuth client id; omitted when `client` names a deployment application", "title": "Client Id" }, "client_secret": { "anyOf": [ { "maxLength": 4096, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "OAuth client secret; omit it for a public client, which authenticates with PKCE alone, and for a registration naming a deployment application. Write-only, sealed at rest and never returned", "title": "Client Secret" }, "scopes": { "description": "Scopes the person is asked to grant; empty asks for none, or for what the named deployment application asks", "items": { "type": "string" }, "maxItems": 32, "title": "Scopes", "type": "array" }, "token_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https?://", "type": "string" }, { "type": "null" } ], "description": "http(s) token endpoint the authorization code and later the refresh token are exchanged at; a literal url, never a template. Omitted when `client` names a deployment application", "title": "Token Url" }, "type": { "const": "oauth_authorization_code", "default": "oauth_authorization_code", "description": "authentication kind", "title": "Type", "type": "string" } }, "title": "OAuthAuthorizationCodeAuth", "type": "object" }, "OAuthClientCredentialsAuth": { "additionalProperties": false, "description": "OAuth 2.0 client credentials: Core exchanges the pair for a token at `token_url` and sends\n`Authorization: Bearer `.\n\nThe token is cached in this process only, never stored (decision 3), and `token_url` is a\ndestination the tenant named, so it is decided by egress policy exactly as the source's own\nhost is.", "properties": { "audience": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "Audience sent with the grant, for a provider that requires one; null omits the parameter", "title": "Audience" }, "client_id": { "description": "OAuth client id", "maxLength": 256, "title": "Client Id", "type": "string" }, "client_secret": { "description": "OAuth client secret; write-only, sealed at rest and never returned", "maxLength": 4096, "minLength": 1, "title": "Client Secret", "type": "string" }, "scopes": { "description": "Scopes requested with the grant; empty asks for none", "items": { "type": "string" }, "maxItems": 32, "title": "Scopes", "type": "array" }, "token_url": { "description": "http(s) token endpoint the client credentials are exchanged at; a literal url, never a template", "maxLength": 2048, "pattern": "^https?://", "title": "Token Url", "type": "string" }, "type": { "const": "oauth_client_credentials", "default": "oauth_client_credentials", "description": "authentication kind", "title": "Type", "type": "string" } }, "required": [ "token_url", "client_id", "client_secret" ], "title": "OAuthClientCredentialsAuth", "type": "object" }, "OfferedTool": { "description": "One tool this call could have offered, and what was decided about it.", "properties": { "decision": { "description": "what happened to it on this call", "enum": [ "offered", "denied_by_policy", "withheld_by_capability", "withheld_for_subject", "hidden_arguments", "routed" ], "title": "Decision", "type": "string" }, "name": { "description": "the tool's name as the model would call it", "title": "Name", "type": "string" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the fixed reason behind a decision that was not `offered`; null otherwise", "title": "Reason" }, "source": { "description": "where the tool came from: system, http, mcp, retrieval or client", "title": "Source", "type": "string" } }, "required": [ "name", "source", "decision" ], "title": "OfferedTool", "type": "object" }, "OidcSignInProviderCreate": { "additionalProperties": false, "description": "An OpenID Connect provider the organisation runs or buys, found through its discovery\ndocument.", "properties": { "client_id": { "description": "The client this organisation registered at its provider for signing in to this deployment", "maxLength": 255, "minLength": 1, "title": "Client Id", "type": "string" }, "client_secret": { "description": "That client's secret. Accepted on every write and never answered back; a replacement must carry it again", "format": "password", "maxLength": 2048, "minLength": 1, "title": "Client Secret", "type": "string", "writeOnly": true }, "display_name": { "anyOf": [ { "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "What the sign-in page calls this provider, when it names it at all", "title": "Display Name" }, "issuer": { "description": "https address of the provider's issuer; its discovery document is read from `/.well-known/openid-configuration`, and every host it names must be one this organisation permits and the deployment does not block. Its ID tokens must carry `email_verified: true`", "format": "uri", "maxLength": 2083, "minLength": 1, "title": "Issuer", "type": "string" }, "kind": { "const": "oidc", "description": "Any OpenID Connect provider, by its issuer", "title": "Kind", "type": "string" } }, "required": [ "client_id", "client_secret", "kind", "issuer" ], "title": "OidcSignInProviderCreate", "type": "object" }, "OrganisationMetadataRead": { "description": "`GET /organisation/metadata`: the opaque document this organisation attached to itself.\n\nThe one route of this router behind no capability at all and reachable by a subject token\ntoo (`app.subjects.reach`): a platform's frontend has to be able to read its own branding\nwith the key it calls with, or with the subject token it hands a browser -- neither of which\nneed hold `management` to ask this one question, unlike everything else under\n`/organisation`.", "properties": { "inheritable_keys": { "description": "The top-level keys of metadata this organisation lends to the organisations below it; empty when it lends none", "items": { "type": "string" }, "title": "Inheritable Keys", "type": "array" }, "metadata": { "additionalProperties": true, "description": "The opaque document this organisation attached to itself; {} when it set none", "title": "Metadata", "type": "object" }, "metadata_version": { "description": "The version of metadata as it is stored now; name it in If-Match on PATCH and the save is refused 409 when metadata changed after this read", "title": "Metadata Version", "type": "string" } }, "required": [ "metadata", "metadata_version", "inheritable_keys" ], "title": "OrganisationMetadataRead", "type": "object" }, "OrganisationPolicyRead": { "description": "What both policy twins answer: the organisation's own document, or `null` when it has none.\n\n`null` rather than a document for one nobody wrote: *no document* leaves every key of this\norganisation decided against its own alone on every kind but a host, and reaches no host\n(`docs/architecture/tenancy.md` \"The organisation's policy document\"). A console card that\ncould not tell the two apart would offer to \"clear\" a document that is already absent and\nwould show a narrowing nobody wrote.", "properties": { "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "latest_version": { "description": "The number of the published version in force; 0 for an organisation no version was ever published for", "title": "Latest Version", "type": "integer" }, "policy": { "anyOf": [ { "$ref": "#/components/schemas/PolicyDocument" }, { "type": "null" } ], "description": "the document this organisation wrote for itself, which every one of its keys is decided against beside its own; null when it wrote none" }, "version": { "description": "the version of the stored document, null included: opaque, and different after every write. Send it back in `If-Match` on a write to have the write refused when the document changed in between", "title": "Version", "type": "string" } }, "required": [ "policy", "version", "latest_version" ], "title": "OrganisationPolicyRead", "type": "object" }, "OrganisationPolicyVersionRead": { "description": "One version of an organisation's own policy document, as the API returns it.", "properties": { "created_at": { "description": "When the version was written", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who wrote the version: a key's id, `operator:` for a person, or null for the version recorded from a document that predates versions", "title": "Created By" }, "digest": { "description": "The digest of `document`: what the document's `version` reads while this version is in force, and what `If-Match` names", "title": "Digest", "type": "string" }, "document": { "anyOf": [ { "$ref": "#/components/schemas/PolicyDocument" }, { "type": "null" } ], "description": "The whole document this version holds; null for the organisation's default, which a `DELETE` of the document publishes" }, "object": { "const": "organisation_policy.version", "default": "organisation_policy.version", "description": "The object's type", "title": "Object", "type": "string" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "state": { "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" } }, "required": [ "version", "state", "published_at", "document", "digest", "created_by", "created_at" ], "title": "OrganisationPolicyVersionRead", "type": "object" }, "OriginRead": { "description": "Where a copy came from, as every read model of a shareable kind reports it -- and\n`null` for a row the tenant wrote itself, which is what a console reads to decide whether to\nsay \"shared by\" at all.", "properties": { "fork": { "default": false, "description": "Whether this copy may be detached and made this organisation's own -- what a console offers a fork button for. The fork route decides it for real, from the version's own terms", "title": "Fork", "type": "boolean" }, "member": { "description": "Name this row has in the publication's manifest", "title": "Member", "type": "string" }, "own_agents_only": { "default": false, "description": "Whether only the agents this same publication installed may use this copy in a turn. Decided for a prompt and a skill; a turn of any other agent, or of none, that names such a copy is refused 403", "title": "Own Agents Only", "type": "boolean" }, "publication_id": { "description": "Publication the subscription installs", "title": "Publication Id", "type": "string" }, "publication_name": { "description": "That publication's name, as its publisher gave it", "title": "Publication Name", "type": "string" }, "sealed": { "description": "Whether the publication's terms withhold this row's content from a reader", "title": "Sealed", "type": "boolean" }, "state": { "description": "'linked' while the publication's syncs own this row, 'forked' once they no longer do, 'suspended' while the subscription that installed it has lapsed", "enum": [ "linked", "forked", "suspended" ], "title": "State", "type": "string" }, "subscription_id": { "description": "Subscription that installed this row", "title": "Subscription Id", "type": "string" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Publication version this copy reflects; null once it is forked", "title": "Version" } }, "required": [ "subscription_id", "publication_id", "publication_name", "member", "version", "state", "sealed" ], "title": "OriginRead", "type": "object" }, "OutputConfigIn": { "additionalProperties": false, "description": "Anthropic's `output_config`: how hard to think, and the shape of the answer.", "properties": { "effort": { "anyOf": [ { "enum": [ "none", "minimal", "low", "medium", "high", "xhigh", "max" ], "type": "string" }, { "type": "null" } ], "description": "how hard the model should think before answering", "title": "Effort" }, "format": { "anyOf": [ { "$ref": "#/components/schemas/JsonFormatIn" }, { "type": "null" } ], "description": "the JSON Schema the output text must satisfy" }, "task_budget": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "an agentic token budget; refused by Core", "title": "Task Budget" } }, "title": "OutputConfigIn", "type": "object" }, "OutputTextContent": { "additionalProperties": false, "description": "The assistant's own generated text.", "properties": { "annotations": { "default": [], "description": "the sources this text cites, each spanning the marker that cites it; empty for text that cites none (`docs/architecture/responses.md#citations`)", "items": { "discriminator": { "mapping": { "file_citation": "#/components/schemas/FileCitation", "url_citation": "#/components/schemas/UrlCitation" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/UrlCitation" }, { "$ref": "#/components/schemas/FileCitation" } ] }, "title": "Annotations", "type": "array" }, "text": { "description": "the assistant's text", "title": "Text", "type": "string" }, "type": { "const": "output_text", "default": "output_text", "description": "output content kind", "title": "Type", "type": "string" } }, "required": [ "text" ], "title": "OutputTextContent", "type": "object" }, "OutputTextPart": { "additionalProperties": false, "description": "An assistant message's own prior text, replayed on the request.", "properties": { "annotations": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "the citations the text carried; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Annotations" }, "logprobs": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "the token log probabilities the text carried; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Logprobs" }, "text": { "description": "the replayed assistant text", "title": "Text", "type": "string" }, "type": { "const": "output_text", "default": "output_text", "description": "content part kind", "title": "Type", "type": "string" } }, "required": [ "text" ], "title": "OutputTextPart", "type": "object" }, "OutputTokensDetails": { "additionalProperties": false, "description": "What the output tokens were made of, where the provider says.", "properties": { "reasoning_tokens": { "default": 0, "description": "the part of `output_tokens` the model spent thinking; 0 where the provider reports no such part", "title": "Reasoning Tokens", "type": "integer" } }, "title": "OutputTokensDetails", "type": "object" }, "PackageName": { "additionalProperties": false, "description": "One package by ecosystem, name and exact version.", "properties": { "ecosystem": { "description": "`pypi` or `npm`", "maxLength": 8, "title": "Ecosystem", "type": "string" }, "name": { "description": "The package's name; a PyPI name is normalised by PEP 503 when it is read", "maxLength": 214, "title": "Name", "type": "string" }, "version": { "description": "The exact version", "maxLength": 64, "title": "Version", "type": "string" } }, "required": [ "ecosystem", "name", "version" ], "title": "PackageName", "type": "object" }, "PackageRead": { "description": "One approved package, of either list.", "properties": { "approval": { "description": "`image` for one the curated image ships, `deployment` for one an operator approved for every organisation, `organisation` for one this organisation approved", "enum": [ "image", "deployment", "organisation" ], "title": "Approval", "type": "string" }, "approved_at": { "description": "When it was approved", "format": "date-time", "title": "Approved At", "type": "string" }, "approved_by": { "description": "Key id, or `operator:`, that approved it, or `image` for a package the curated image ships; an organisation reads a deployment entry's as `operator`", "title": "Approved By", "type": "string" }, "ecosystem": { "description": "`pypi` or `npm`", "title": "Ecosystem", "type": "string" }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The file's own name; null for an image package", "title": "Filename" }, "id": { "description": "Package id", "title": "Id", "type": "string" }, "name": { "description": "The package's name, normalised", "title": "Name", "type": "string" }, "object": { "const": "package", "default": "package", "description": "The object's type", "title": "Object", "type": "string" }, "sha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SHA-256 hex digest of the file; null for an image one", "title": "Sha256" }, "size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The file's length; null for an image package", "title": "Size Bytes" }, "version": { "description": "The exact version", "title": "Version", "type": "string" } }, "required": [ "id", "approval", "ecosystem", "name", "version", "filename", "sha256", "size_bytes", "approved_by", "approved_at" ], "title": "PackageRead", "type": "object" }, "PageCreate": { "additionalProperties": false, "description": "Body of `POST /pages`: the name, and the stored HTML file that becomes version 1.", "properties": { "file_id": { "description": "The stored HTML file or artifact published as version 1. It is kept past the organisation's retention window from now on", "maxLength": 128, "minLength": 1, "title": "File Id", "type": "string" }, "name": { "description": "The page's name, unique in the organisation: lower-case letters, digits and hyphens, 1 to 64 characters", "pattern": "^[a-z0-9-]{1,64}$", "title": "Name", "type": "string" } }, "required": [ "name", "file_id" ], "title": "PageCreate", "type": "object" }, "PageRead": { "description": "One page: a stable name over the published versions of a stored HTML file, and which of\nthem it shows now.", "properties": { "created_at": { "description": "When the page was first published", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that published version 1", "title": "Created By", "type": "string" }, "current_version": { "description": "The number of the version the page shows now", "title": "Current Version", "type": "integer" }, "file_id": { "description": "The stored file or artifact of the current version", "title": "File Id", "type": "string" }, "id": { "description": "Page id", "title": "Id", "type": "string" }, "name": { "description": "The page's name, unique in the organisation", "title": "Name", "type": "string" }, "object": { "const": "page", "default": "page", "description": "The object's type", "title": "Object", "type": "string" }, "updated_at": { "description": "When a version was last published or the page last changed", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "name", "current_version", "file_id", "created_by", "created_at", "updated_at" ], "title": "PageRead", "type": "object" }, "PageUpdate": { "additionalProperties": false, "description": "Body of `PATCH /pages/{page_id}`; an absent field is left alone.", "properties": { "current_version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "The number of the version the page shows from now on: an earlier one to roll back, a later one to roll forward. A number the page does not have is `422`", "title": "Current Version" }, "name": { "anyOf": [ { "pattern": "^[a-z0-9-]{1,64}$", "type": "string" }, { "type": "null" } ], "description": "A new name for the page, unique in the organisation. The page's id, its views and its share links are unchanged", "title": "Name" } }, "title": "PageUpdate", "type": "object" }, "PageVersionCreate": { "additionalProperties": false, "description": "Body of `POST /pages/{page_id}/versions`: the stored HTML file that becomes the next\nversion.", "properties": { "file_id": { "description": "The stored HTML file or artifact published as the next version, which the page shows from now on. It must be for the same person as the page and governed as its other versions are, and is kept past the retention window from now on", "maxLength": 128, "minLength": 1, "title": "File Id", "type": "string" } }, "required": [ "file_id" ], "title": "PageVersionCreate", "type": "object" }, "PageVersionRead": { "description": "One published version of a page: its number and the stored file it shows.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "created_at": { "description": "When this version was published", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that published it", "title": "Created By", "type": "string" }, "file_id": { "description": "The stored file or artifact this version shows", "title": "File Id", "type": "string" }, "number": { "description": "The version's number within its page, from 1", "title": "Number", "type": "integer" }, "object": { "const": "page.version", "default": "page.version", "description": "The object's type", "title": "Object", "type": "string" } }, "required": [ "number", "file_id", "created_by", "acted_for", "created_at" ], "title": "PageVersionRead", "type": "object" }, "Page_AgentRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/AgentRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[AgentRead]", "type": "object" }, "Page_AgentVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/AgentVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[AgentVersionRead]", "type": "object" }, "Page_AnalysisRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/AnalysisRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[AnalysisRead]", "type": "object" }, "Page_Annotated_Union_ThreadMessage__ThreadReasoning__ThreadFunctionCall__ThreadCustomToolCall__ToolResultRead___FieldInfo_annotation_NoneType__required_True__discriminator__type____": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "discriminator": { "mapping": { "custom_tool_call": "#/components/schemas/ThreadCustomToolCall", "function_call": "#/components/schemas/ThreadFunctionCall", "function_call_output": "#/components/schemas/ToolResultRead", "message": "#/components/schemas/ThreadMessage", "reasoning": "#/components/schemas/ThreadReasoning" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ThreadMessage" }, { "$ref": "#/components/schemas/ThreadReasoning" }, { "$ref": "#/components/schemas/ThreadFunctionCall" }, { "$ref": "#/components/schemas/ThreadCustomToolCall" }, { "$ref": "#/components/schemas/ToolResultRead" } ] }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[Annotated[Union[ThreadMessage, ThreadReasoning, ThreadFunctionCall, ThreadCustomToolCall, ToolResultRead], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]", "type": "object" }, "Page_ApiConnectorRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ApiConnectorRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ApiConnectorRead]", "type": "object" }, "Page_ApiConnectorVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ApiConnectorVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ApiConnectorVersionRead]", "type": "object" }, "Page_ArtifactRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ArtifactRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ArtifactRead]", "type": "object" }, "Page_AssetRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/AssetRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[AssetRead]", "type": "object" }, "Page_AuditEventRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/AuditEventRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[AuditEventRead]", "type": "object" }, "Page_CatalogueListingRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/CatalogueListingRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[CatalogueListingRead]", "type": "object" }, "Page_CollectionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/CollectionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[CollectionRead]", "type": "object" }, "Page_ComputerEgressObject_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ComputerEgressObject" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ComputerEgressObject]", "type": "object" }, "Page_ComputerObject_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ComputerObject" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ComputerObject]", "type": "object" }, "Page_ControlEventRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ControlEventRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ControlEventRead]", "type": "object" }, "Page_DatastoreRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/DatastoreRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[DatastoreRead]", "type": "object" }, "Page_DatastoreRecordRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/DatastoreRecordRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[DatastoreRecordRead]", "type": "object" }, "Page_DatastoreSchemaVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/DatastoreSchemaVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[DatastoreSchemaVersionRead]", "type": "object" }, "Page_EmailDomainRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/EmailDomainRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[EmailDomainRead]", "type": "object" }, "Page_EntitlementRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/EntitlementRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[EntitlementRead]", "type": "object" }, "Page_EntityRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/EntityRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[EntityRead]", "type": "object" }, "Page_EvaluationRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/EvaluationRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[EvaluationRead]", "type": "object" }, "Page_EvaluationVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/EvaluationVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[EvaluationVersionRead]", "type": "object" }, "Page_EventSubscriptionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/EventSubscriptionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[EventSubscriptionRead]", "type": "object" }, "Page_ExportRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ExportRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ExportRead]", "type": "object" }, "Page_FileRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/FileRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[FileRead]", "type": "object" }, "Page_FunctionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/FunctionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[FunctionRead]", "type": "object" }, "Page_FunctionVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/FunctionVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[FunctionVersionRead]", "type": "object" }, "Page_GraphRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/GraphRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[GraphRead]", "type": "object" }, "Page_GraphRunRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/GraphRunRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[GraphRunRead]", "type": "object" }, "Page_GraphSchemaVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/GraphSchemaVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[GraphSchemaVersionRead]", "type": "object" }, "Page_Hit_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/Hit" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[Hit]", "type": "object" }, "Page_IndexRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/IndexRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[IndexRead]", "type": "object" }, "Page_IndexRunRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/IndexRunRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[IndexRunRead]", "type": "object" }, "Page_ItemMetadataRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ItemMetadataRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ItemMetadataRead]", "type": "object" }, "Page_KeyRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/KeyRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[KeyRead]", "type": "object" }, "Page_MailConnectorRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/MailConnectorRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[MailConnectorRead]", "type": "object" }, "Page_MailConnectorVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/MailConnectorVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[MailConnectorVersionRead]", "type": "object" }, "Page_MarkupRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/MarkupRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[MarkupRead]", "type": "object" }, "Page_McpServerRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/McpServerRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[McpServerRead]", "type": "object" }, "Page_McpServerVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/McpServerVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[McpServerVersionRead]", "type": "object" }, "Page_McpToolRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/McpToolRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[McpToolRead]", "type": "object" }, "Page_MemoryRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/MemoryRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[MemoryRead]", "type": "object" }, "Page_MemorySearchHit_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/MemorySearchHit" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[MemorySearchHit]", "type": "object" }, "Page_MemoryStoreRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/MemoryStoreRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[MemoryStoreRead]", "type": "object" }, "Page_ModelCallRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ModelCallRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ModelCallRead]", "type": "object" }, "Page_ModelReferenceRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ModelReferenceRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ModelReferenceRead]", "type": "object" }, "Page_ModelRoleRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ModelRoleRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ModelRoleRead]", "type": "object" }, "Page_ModelRouterRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ModelRouterRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ModelRouterRead]", "type": "object" }, "Page_ModelRouterVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ModelRouterVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ModelRouterVersionRead]", "type": "object" }, "Page_OrganisationPolicyVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/OrganisationPolicyVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[OrganisationPolicyVersionRead]", "type": "object" }, "Page_PackageRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/PackageRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[PackageRead]", "type": "object" }, "Page_PageRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/PageRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[PageRead]", "type": "object" }, "Page_PageVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/PageVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[PageVersionRead]", "type": "object" }, "Page_PipelineModelRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/PipelineModelRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[PipelineModelRead]", "type": "object" }, "Page_PipelineRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/PipelineRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[PipelineRead]", "type": "object" }, "Page_PipelineTemplateRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/PipelineTemplateRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[PipelineTemplateRead]", "type": "object" }, "Page_PipelineVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/PipelineVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[PipelineVersionRead]", "type": "object" }, "Page_PromptRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/PromptRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[PromptRead]", "type": "object" }, "Page_PromptVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/PromptVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[PromptVersionRead]", "type": "object" }, "Page_ProposalRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ProposalRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ProposalRead]", "type": "object" }, "Page_PseudonymRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/PseudonymRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[PseudonymRead]", "type": "object" }, "Page_PublicationRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/PublicationRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[PublicationRead]", "type": "object" }, "Page_PublicationVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/PublicationVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[PublicationVersionRead]", "type": "object" }, "Page_RelationRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/RelationRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[RelationRead]", "type": "object" }, "Page_ResponseCheckRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ResponseCheckRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ResponseCheckRead]", "type": "object" }, "Page_RetrievalToolRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/RetrievalToolRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[RetrievalToolRead]", "type": "object" }, "Page_RetrievalToolVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/RetrievalToolVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[RetrievalToolVersionRead]", "type": "object" }, "Page_RoutingConfigRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/RoutingConfigRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[RoutingConfigRead]", "type": "object" }, "Page_RoutingConfigVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/RoutingConfigVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[RoutingConfigVersionRead]", "type": "object" }, "Page_RunSummary_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/RunSummary" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[RunSummary]", "type": "object" }, "Page_ScheduleObject_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ScheduleObject" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ScheduleObject]", "type": "object" }, "Page_ScheduleResponseSummary_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ScheduleResponseSummary" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ScheduleResponseSummary]", "type": "object" }, "Page_ScriptRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ScriptRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ScriptRead]", "type": "object" }, "Page_ScriptVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ScriptVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ScriptVersionRead]", "type": "object" }, "Page_ServiceAccountRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ServiceAccountRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ServiceAccountRead]", "type": "object" }, "Page_ServiceAccountRun_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ServiceAccountRun" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ServiceAccountRun]", "type": "object" }, "Page_ShareLinkRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ShareLinkRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ShareLinkRead]", "type": "object" }, "Page_SignInProviderRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/SignInProviderRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[SignInProviderRead]", "type": "object" }, "Page_SkillRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/SkillRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[SkillRead]", "type": "object" }, "Page_SkillVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/SkillVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[SkillVersionRead]", "type": "object" }, "Page_SourceGraphStateRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/SourceGraphStateRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[SourceGraphStateRead]", "type": "object" }, "Page_SourceIndexStateRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/SourceIndexStateRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[SourceIndexStateRead]", "type": "object" }, "Page_SourceRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/SourceRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[SourceRead]", "type": "object" }, "Page_SqlConnectorRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/SqlConnectorRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[SqlConnectorRead]", "type": "object" }, "Page_SqlConnectorVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/SqlConnectorVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[SqlConnectorVersionRead]", "type": "object" }, "Page_SubscriptionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/SubscriptionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[SubscriptionRead]", "type": "object" }, "Page_SyncRunRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/SyncRunRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[SyncRunRead]", "type": "object" }, "Page_TableRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/TableRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[TableRead]", "type": "object" }, "Page_TaskRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/TaskRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[TaskRead]", "type": "object" }, "Page_TenantAdminRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/TenantAdminRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[TenantAdminRead]", "type": "object" }, "Page_TenantRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/TenantRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[TenantRead]", "type": "object" }, "Page_ThreadRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ThreadRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ThreadRead]", "type": "object" }, "Page_ThreadSummaryRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ThreadSummaryRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ThreadSummaryRead]", "type": "object" }, "Page_ToolAliasRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ToolAliasRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ToolAliasRead]", "type": "object" }, "Page_ToolAliasVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ToolAliasVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ToolAliasVersionRead]", "type": "object" }, "Page_ToolRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ToolRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ToolRead]", "type": "object" }, "Page_ToolsetRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ToolsetRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ToolsetRead]", "type": "object" }, "Page_ToolsetVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/ToolsetVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[ToolsetVersionRead]", "type": "object" }, "Page_TranscriptionJobRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/TranscriptionJobRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[TranscriptionJobRead]", "type": "object" }, "Page_UploadSessionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/UploadSessionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[UploadSessionRead]", "type": "object" }, "Page_UsageRecordRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/UsageRecordRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[UsageRecordRead]", "type": "object" }, "Page_WorkflowDecisionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/WorkflowDecisionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[WorkflowDecisionRead]", "type": "object" }, "Page_WorkflowRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/WorkflowRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[WorkflowRead]", "type": "object" }, "Page_WorkflowRunRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/WorkflowRunRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[WorkflowRunRead]", "type": "object" }, "Page_WorkflowTriggerRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/WorkflowTriggerRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[WorkflowTriggerRead]", "type": "object" }, "Page_WorkflowVersionRead_": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "$ref": "#/components/schemas/WorkflowVersionRead" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[WorkflowVersionRead]", "type": "object" }, "Page_dict_str__Any__": { "properties": { "items": { "description": "the rows for this page, in keyset order", "items": { "additionalProperties": true, "type": "object" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to fetch the next page; absent once there is no more", "title": "Next Cursor" } }, "required": [ "items" ], "title": "Page[dict[str, Any]]", "type": "object" }, "ParamDef": { "additionalProperties": false, "description": "One component parameter: its type, bounds/options, default and a caller-facing description.\n\n`min`/`max` apply to `int`/`float` only; `options` to `enum` only. A string parameter's own\nlength limit (e.g. `instructions`, capped at `MAX_INSTRUCTION_CHARS`) is enforced by\n`app.knowledge.pipelines.validation` at write time, not here and not by the component at run\ntime -- this shape (ported from the platform's `ParamDef`) has no length field.", "properties": { "default": { "description": "value used when the pipeline omits this key", "title": "Default" }, "description": { "description": "what this parameter controls", "title": "Description", "type": "string" }, "max": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "description": "maximum value, for int/float", "title": "Max" }, "min": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "description": "minimum value, for int/float", "title": "Min" }, "options": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "allowed values, for enum", "title": "Options" }, "type": { "description": "the parameter's value type", "enum": [ "int", "float", "bool", "string", "enum" ], "title": "Type", "type": "string" } }, "required": [ "type", "description" ], "title": "ParamDef", "type": "object" }, "ParameterReport": { "additionalProperties": false, "description": "Which parameters still have no value, and which bound servers lack a tool the bundle\nexpects.", "properties": { "missing": { "description": "Required parameters with neither a supplied value nor a default; a subscription with any of them waits at needs_configuration", "items": { "type": "string" }, "title": "Missing", "type": "array" }, "tools_missing": { "description": "Per mcp_server parameter bound to one of this organisation's servers, the declared tools that server does not offer. Advice, not a refusal: a server's tool list is a cache its own sync refreshes", "items": { "$ref": "#/components/schemas/ToolsMissing" }, "title": "Tools Missing", "type": "array" } }, "title": "ParameterReport", "type": "object" }, "ParameterSpec": { "additionalProperties": false, "description": "One declared parameter: what the subscriber must supply, and what counts as a value.", "properties": { "allowed": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "the values an enum parameter admits; required for enum, optional elsewhere", "title": "Allowed" }, "default": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "description": "the value used when the subscription supplies none", "title": "Default" }, "description": { "default": "", "description": "what this parameter is for, shown at install", "maxLength": 1024, "title": "Description", "type": "string" }, "hosts": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 64, "type": "array" }, { "type": "null" } ], "description": "fnmatch globs the host of a url parameter's value must match; null accepts any host; whether it is reached is the subscriber's own allowed hosts to decide", "title": "Hosts" }, "kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "which credential a credential parameter asks for: bearer, api_key, basic, oauth_client_credentials or oauth_authorization_code -- the last being the OAuth application the subscriber registered at the vendor itself, never anybody's login; required for credential and refused elsewhere", "title": "Kind" }, "required": { "default": false, "description": "whether a subscription without a value for it is held at needs_configuration", "title": "Required", "type": "boolean" }, "tools": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 64, "type": "array" }, { "type": "null" } ], "description": "the tools the MCP server an mcp_server parameter binds must offer; one it does not offer is reported at install (parameters.tools_missing) and never refused, because what a server offers is a cache its own sync refreshes. Refused on every other type", "title": "Tools" }, "type": { "description": "the parameter's type: model, string, enum, number, url, credential, or one whose value is the id of a row the subscriber already has -- collection, index, key, mcp_server or api_connector", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "ParameterSpec", "type": "object" }, "Parameterised": { "additionalProperties": false, "description": "One field of a chosen row the installer fills in instead of the publisher: Core writes the\nparameter marker where the row's own value stood, so a publisher never writes a manifest by\nhand to let a subscriber choose.\n\nA **scalar** field (`model`, `instructions`, `description`, `url`, ...) is replaced whole and\ntakes no `match`; when the declared parameter has no `default`, the row's current value\nbecomes it -- the publisher's own value is the installer's starting point. A **list** field\nnames the one entry it replaces with `match`: a toolset glob or an agent's tool reference\n(`mcp__hubspot__*`, `mcp__hubspot__search`, `api__lookup`) becomes a bound-connector marker\nwhose tool half is taken from the name, and an index link names its collection.", "properties": { "field": { "description": "the definition field the installer fills in: one the member's kind accepts a parameter in, or the tool-name field (`tools` on an agent or a toolset, `target` on a tool alias)", "maxLength": 64, "title": "Field", "type": "string" }, "match": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "description": "for a list field, the current entry to replace -- a qualified tool name or glob, or an index link's collection name; refused for a scalar field", "title": "Match" }, "parameter": { "description": "the parameter, declared in the same request, whose value stands in the field; its type must be one the field accepts", "maxLength": 64, "title": "Parameter", "type": "string" } }, "required": [ "field", "parameter" ], "title": "Parameterised", "type": "object" }, "PipelineComponentRead": { "additionalProperties": false, "description": "One component kind, as `GET /knowledge/pipeline-components` lists it for one phase.", "properties": { "accepts": { "description": "Port kinds the main input takes; empty for a kind that takes no input", "items": { "enum": [ "raw", "documents", "chunks", "rows", "facts", "memories", "stored", "retrieval", "text", "metadata", "filters", "question", "index", "collection", "graph" ], "type": "string" }, "title": "Accepts", "type": "array" }, "available": { "description": "Whether this deployment can run this kind", "title": "Available", "type": "boolean" }, "category": { "description": "Editor grouping", "enum": [ "Pipeline", "Sources", "Loading", "Splitters", "Enrichment", "Storage", "Search", "Reranking", "Post-processing", "Augmentation" ], "title": "Category", "type": "string" }, "defaults": { "additionalProperties": true, "description": "Each parameter's default, by name", "title": "Defaults", "type": "object" }, "description": { "description": "What this component does", "title": "Description", "type": "string" }, "emits": { "anyOf": [ { "enum": [ "raw", "documents", "chunks", "rows", "facts", "memories", "stored", "retrieval", "text", "metadata", "filters", "question", "index", "collection", "graph" ], "type": "string" }, { "type": "null" } ], "description": "Port kind the main output hands on", "title": "Emits" }, "icon": { "description": "Editor icon name", "title": "Icon", "type": "string" }, "inputs": { "description": "Every input port, the main one first; an edge naming no `target_port` reaches the main one", "items": { "$ref": "#/components/schemas/PortSpec" }, "title": "Inputs", "type": "array" }, "label": { "description": "Human-readable name shown in the editor", "title": "Label", "type": "string" }, "locked": { "description": "input/output: cannot be deleted or retyped", "title": "Locked", "type": "boolean" }, "outputs": { "description": "Every output port, the main one first; an edge naming no `source_port` leaves the main one", "items": { "$ref": "#/components/schemas/PortSpec" }, "title": "Outputs", "type": "array" }, "params": { "additionalProperties": { "$ref": "#/components/schemas/ParamDef" }, "description": "This component's parameters, by name", "title": "Params", "type": "object" }, "requires": { "description": "Deployment capabilities this kind needs", "items": { "enum": [ "embeddings", "chat_model", "llama_parse", "image_embeddings" ], "type": "string" }, "title": "Requires", "type": "array" }, "type": { "description": "Component type; a node's `type` names this", "title": "Type", "type": "string" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why this kind cannot run here, naming a capability and never a vendor; null when available", "title": "Unavailable Reason" } }, "required": [ "type", "label", "icon", "description", "category", "defaults", "params", "locked", "requires", "available", "unavailable_reason", "accepts", "emits", "inputs", "outputs" ], "title": "PipelineComponentRead", "type": "object" }, "PipelineComponentsRead": { "additionalProperties": false, "description": "The component registry, one listing per pipeline kind, each keyed by component type.", "properties": { "ingest": { "additionalProperties": { "$ref": "#/components/schemas/PipelineComponentRead" }, "description": "Every kind an ingest pipeline may use, `input`/`output` included", "title": "Ingest", "type": "object" }, "retrieval": { "additionalProperties": { "$ref": "#/components/schemas/PipelineComponentRead" }, "description": "Every kind a retrieval pipeline may use, `input`/`output` included", "title": "Retrieval", "type": "object" } }, "required": [ "ingest", "retrieval" ], "title": "PipelineComponentsRead", "type": "object" }, "PipelineConfig": { "additionalProperties": false, "description": "`nodes` and `edges` form a DAG from exactly one `input` node to exactly one `output` node;\nevery node lies on a path between them, or -- for a kind that takes no input\n(`SOURCE_TYPES`) -- on a path from itself to `output`. Component types, parameters and ports\nare checked against the registry by `app.knowledge.pipelines.validation`, not here.", "properties": { "edges": { "description": "data flow between nodes", "items": { "$ref": "#/components/schemas/EdgeConfig" }, "title": "Edges", "type": "array" }, "nodes": { "description": "the components", "items": { "$ref": "#/components/schemas/NodeConfig" }, "maxItems": 32, "minItems": 2, "title": "Nodes", "type": "array" } }, "required": [ "nodes" ], "title": "PipelineConfig", "type": "object" }, "PipelineCreate": { "additionalProperties": false, "description": "Body of `POST /knowledge/pipelines`: creates the pipeline and its first version (1) together.\n\n`config` is wire-typed as a plain JSON object, not `PipelineConfig`: were it the typed model,\na structural mistake (e.g. a repeated node id) would fail FastAPI's own body parsing before\n`app.knowledge.pipeline_service._validate_config` ever ran, landing in `errors[]` as\n`body.config` -- a different namespace from the `config`/`config.nodes[i]...` a registry\nfailure (checked in that same function, against this deployment's catalogue) names. Wire-\ntyping it loose lets one function own both checks and render both the same way -- the\nkernel-wide rule (`docs/architecture/api-conventions.md` \"Field namespaces in a 422's\nerrors[]\"): a FastAPI body-parsing error keeps its own `body.` field; domain validation\nraised by a route or service names the field with no prefix.", "properties": { "config": { "additionalProperties": true, "description": "The DAG (`nodes`/`edges`), checked against the component registry", "title": "Config", "type": "object" }, "description": { "default": "", "description": "Human-readable description", "maxLength": 1024, "title": "Description", "type": "string" }, "kind": { "description": "'ingest' or 'retrieval'", "enum": [ "ingest", "retrieval" ], "title": "Kind", "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the pipeline, at most 16 KiB serialised: stored, returned and never read by Core; omitted or null stores {}", "title": "Metadata" }, "name": { "description": "Unique name within the tenant", "pattern": "^[A-Za-z0-9_-]{1,64}$", "title": "Name", "type": "string" } }, "required": [ "name", "kind", "config" ], "title": "PipelineCreate", "type": "object" }, "PipelineFromTemplateCreate": { "additionalProperties": false, "description": "Body of `POST /knowledge/pipelines/from-template`: copies a built-in template into a new,\ntenant-owned pipeline whose version 1 is the template's graph with its source blocks filled.\n\nA retrieval template carries its `index`, `collection` and `graph` blocks empty: it is a\nstarting point, and which index, collection or graph a search reads is the organisation's to\nsay. `sources`\nfills every one of them by node id; an ingest template has none, and takes none.", "properties": { "name": { "description": "Unique name within the tenant", "pattern": "^[A-Za-z0-9_-]{1,64}$", "title": "Name", "type": "string" }, "sources": { "additionalProperties": { "type": "string" }, "description": "What each of the template's source blocks stands for, by node id: an index id for an `index` block, a collection id for a `collection` block, a knowledge graph id for a `graph` block. Every block must be named, and each id is checked against the calling key's own policy. A node id is at most 64 characters of letters, digits, `_` and `-`, an id at most 64 characters", "maxProperties": 32, "title": "Sources", "type": "object" }, "template": { "description": "Built-in template id, e.g. 'ingest/basic'", "title": "Template", "type": "string" } }, "required": [ "template", "name" ], "title": "PipelineFromTemplateCreate", "type": "object" }, "PipelineModelRead": { "description": "One chat model a step of this pipeline's latest version calls, with where it runs and\nwhether the calling key's policy admits it -- `GET /knowledge/pipelines/{id}/models`.", "properties": { "allowed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the calling key's policy admits the model right now, decided as the step's own call is; null when `model` is null. A retrieval step is decided under the key whose turn or request runs it, an ingest step under the key that created the source, so for an ingest pipeline this is the answer for sources this key creates. Refused, the step fails `policy_denied`", "title": "Allowed" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Country the model runs in as an ISO 3166-1 alpha-2 code, when the operator claims one", "title": "Country" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Catalogue id of the chat model the step calls; null when the step names none and calls the turn's own model, which is decided with the turn", "title": "Model" }, "node_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the step that calls the model; null when the pipeline is sealed, which withholds its graph", "title": "Node Id" }, "node_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Component type of that step, e.g. 'llm_reranker'; null when the pipeline is sealed", "title": "Node Type" }, "object": { "const": "pipeline_model", "default": "pipeline_model", "description": "The object's type", "title": "Object", "type": "string" }, "region": { "anyOf": [ { "enum": [ "eu", "us", "in-cluster", "global" ], "type": "string" }, { "type": "null" } ], "description": "Jurisdiction the model runs in, as the operator asserts it; null when `model` is null or the catalogue holds no chat model by that id, which a key that names regions is refused on", "title": "Region" } }, "required": [ "node_id", "node_type", "model", "region", "country", "allowed" ], "title": "PipelineModelRead", "type": "object" }, "PipelineRead": { "description": "A pipeline, as the API returns it: its identity plus its latest version in full -- never\njust a version number, so a caller reading one pipeline always sees what it currently runs.", "properties": { "created_at": { "description": "When the pipeline was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created the pipeline: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "description": { "description": "Human-readable description", "title": "Description", "type": "string" }, "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "id": { "description": "Pipeline id", "title": "Id", "type": "string" }, "kind": { "description": "'ingest' or 'retrieval'", "enum": [ "ingest", "retrieval" ], "title": "Kind", "type": "string" }, "latest_version": { "$ref": "#/components/schemas/PipelineVersionRead", "description": "The highest published version, the one every pin naming no number would take; on the management twin, the newest draft while nothing is published" }, "metadata": { "additionalProperties": true, "default": {}, "description": "The opaque document attached to this pipeline; {} when none was set", "title": "Metadata", "type": "object" }, "name": { "description": "Unique name within the tenant", "title": "Name", "type": "string" }, "object": { "const": "knowledge_pipeline", "default": "knowledge_pipeline", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/OriginRead" }, { "type": "null" } ], "description": "The subscription that installed this pipeline, and the publication it came from; null for a pipeline this organisation wrote itself" }, "template": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Built-in template this pipeline was cloned from, if any", "title": "Template" }, "updated_at": { "description": "When the pipeline last gained a new version", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "name", "kind", "description", "latest_version", "created_by", "created_at", "updated_at" ], "title": "PipelineRead", "type": "object" }, "PipelineRef": { "additionalProperties": false, "description": "A reference to a pipeline: either a tenant-owned `(pipeline_id, version)` or a built-in\n`template` name, never both.", "properties": { "pipeline_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant-owned pipeline id", "title": "Pipeline Id" }, "template": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Built-in template id", "title": "Template" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Pinned version of `pipeline_id`", "title": "Version" } }, "title": "PipelineRef", "type": "object" }, "PipelineTemplateRead": { "description": "One built-in template, as `GET /knowledge/pipeline-templates` lists it.", "properties": { "config": { "$ref": "#/components/schemas/PipelineConfig", "description": "The DAG a clone starts with" }, "description": { "description": "Human-readable explanation of what this template does", "title": "Description", "type": "string" }, "id": { "description": "Template id, e.g. 'ingest/basic'", "title": "Id", "type": "string" }, "kind": { "description": "'ingest' or 'retrieval'", "enum": [ "ingest", "retrieval" ], "title": "Kind", "type": "string" }, "name": { "description": "Human-readable name", "title": "Name", "type": "string" } }, "required": [ "id", "kind", "name", "description", "config" ], "title": "PipelineTemplateRead", "type": "object" }, "PipelineTestRead": { "description": "What a dry run produced. A `retrieval` run fills `results`/`answer`, an `ingest` run fills\n`chunks`; both carry the trace, and neither wrote anything.", "properties": { "answer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "retrieval: the answer a synthesizing node wrote", "title": "Answer" }, "chunks": { "description": "ingest: the chunks `store` would have written", "items": { "$ref": "#/components/schemas/ChunkRead" }, "title": "Chunks", "type": "array" }, "kind": { "description": "Which kind of pipeline ran", "enum": [ "ingest", "retrieval" ], "title": "Kind", "type": "string" }, "object": { "const": "pipeline_test", "default": "pipeline_test", "description": "The object's type", "title": "Object", "type": "string" }, "results": { "description": "retrieval: the ranked hits", "items": { "$ref": "#/components/schemas/Hit" }, "title": "Results", "type": "array" }, "trace": { "description": "One entry per node that ran, in run order", "items": { "$ref": "#/components/schemas/TraceEntry" }, "title": "Trace", "type": "array" }, "version": { "description": "The version that ran", "title": "Version", "type": "integer" } }, "required": [ "kind", "version", "trace" ], "title": "PipelineTestRead", "type": "object" }, "PipelineTestRequest": { "additionalProperties": false, "description": "Body of `POST /knowledge/pipelines/{id}/test`, for either kind: a `retrieval` pipeline\nneeds `query` and reads the sources its own blocks name, an `ingest` pipeline needs `text`.\nSending the other kind's fields is a 422 naming what this pipeline actually wanted.", "properties": { "media_type": { "default": "text/plain", "description": "ingest: the text's media type", "maxLength": 255, "title": "Media Type", "type": "string" }, "query": { "anyOf": [ { "maxLength": 4000, "type": "string" }, { "type": "null" } ], "description": "retrieval: the question to run", "title": "Query" }, "text": { "anyOf": [ { "maxLength": 100000, "type": "string" }, { "type": "null" } ], "description": "ingest: the text to run", "title": "Text" }, "top_k": { "anyOf": [ { "maximum": 50.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "retrieval: cap on the hits returned", "title": "Top K" }, "version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "Pipeline version to run; the latest if null", "title": "Version" } }, "title": "PipelineTestRequest", "type": "object" }, "PipelineUpdate": { "additionalProperties": false, "description": "Body of `PATCH /knowledge/pipelines/{id}`; absent fields are left alone. The DAG itself is\nnever patched -- a change is always a new version.", "properties": { "description": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "Human-readable description", "title": "Description" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "new opaque document, replacing whatever is stored whole; omitted leaves it alone, and {} clears it", "title": "Metadata" }, "name": { "anyOf": [ { "pattern": "^[A-Za-z0-9_-]{1,64}$", "type": "string" }, { "type": "null" } ], "description": "Unique name within the tenant", "title": "Name" } }, "title": "PipelineUpdate", "type": "object" }, "PipelineVersionCreate": { "additionalProperties": false, "description": "Body of `POST /knowledge/pipelines/{id}/versions`: adds a new, immutable version to a\npipeline.\n\n`config` is wire-typed loose for the same reason `PipelineCreate.config` is -- see there.", "properties": { "config": { "additionalProperties": true, "description": "The DAG (`nodes`/`edges`), checked against the component registry", "title": "Config", "type": "object" } }, "required": [ "config" ], "title": "PipelineVersionCreate", "type": "object" }, "PipelineVersionRead": { "description": "One immutable pipeline version, as the API returns it.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "config": { "anyOf": [ { "$ref": "#/components/schemas/PipelineConfig" }, { "type": "null" } ], "description": "The DAG this version stores; null when the publication that shared this pipeline seals it, which withholds the graph from every reader while a turn still runs it" }, "created_at": { "description": "When this version was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created the version: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "id": { "description": "Pipeline version id", "title": "Id", "type": "string" }, "object": { "const": "pipeline_version", "default": "pipeline_version", "description": "The object's type", "title": "Object", "type": "string" }, "pipeline_id": { "description": "Owning pipeline id", "title": "Pipeline Id", "type": "string" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "sealed": { "default": false, "description": "Whether this version was installed under sealed terms, so its content is withheld here for good -- whatever a later version of the same copy says, and after a fork. A version this organisation wrote itself is never sealed", "title": "Sealed", "type": "boolean" }, "state": { "default": "published", "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" } }, "required": [ "id", "pipeline_id", "version", "config", "created_by", "acted_for", "created_at" ], "title": "PipelineVersionRead", "type": "object" }, "PolicyAnswer": { "description": "One question answered under the version tried and under the published document.", "properties": { "draft": { "$ref": "#/components/schemas/PolicyVerdict", "description": "The answer with the document tried in force" }, "kind": { "description": "The kind asked about", "enum": [ "model", "router", "tool", "prompt", "skill", "file", "agent", "schedule", "workflow", "knowledge_collection", "knowledge_index", "knowledge_graph", "datastore", "egress_host", "artifact_download", "share_link", "memory_write", "direct_turn", "thread", "memory_record", "knowledge_source", "stored_file", "datastore_record" ], "title": "Kind", "type": "string" }, "name": { "description": "The name asked about", "title": "Name", "type": "string" }, "published": { "$ref": "#/components/schemas/PolicyVerdict", "description": "The answer with the published document in force" } }, "required": [ "kind", "name", "draft", "published" ], "title": "PolicyAnswer", "type": "object" }, "PolicyDocument": { "additionalProperties": false, "description": "The rules a key or an organisation is decided under, and its settings.\n\nA value embedded in key and organisation bodies, not a resource of its own, so it has no\n`Create`/`Update`/`Read` forms: it is always sent and answered whole.", "properties": { "rules": { "description": "the rules, in no order that matters: a thing is reached when no `forbid` matches it and some `permit` does, and refused otherwise. At most 500, naming at most 2000 patterns together. Omitted on a key, the key's default rules are stored: every model, router, tool and named resource, artifact download and every knowledge source permitted; no memory write and no share link; threads, memory records, stored files and datastore records permitted whole to a request that names nobody, and to a person her own rows and the shared ones. A key's document that writes no permit over `egress_host` reaches the hosts its organisation permits; one that writes any reaches only those its organisation permits too. Omitted on an organisation's document, the organisation's default rules are stored: every kind permitted whole, except `egress_host` and `share_link`, which hold no rule -- no host is reached and no page shared through a link until the organisation permits it. A host is reached only when the organisation's document permits it, whatever a key's says. An empty list permits nothing. Rules over `model` decide the deployment's embedding model too: a document that permits chat models alone leaves its key unable to embed, and so without retrieval", "items": { "$ref": "#/components/schemas/Rule" }, "maxItems": 500, "title": "Rules", "type": "array" }, "settings": { "$ref": "#/components/schemas/PolicySettings", "description": "what the document says that is not a rule: whether a subject or an agent is required, which label values a person may write, where data may go, and how long a share link may live" } }, "title": "PolicyDocument", "type": "object" }, "PolicyDocumentDecisionsAsk": { "additionalProperties": false, "description": "What a key's try of a policy document asks: the document inline, as a `PUT` would send it,\nnever a stored draft.", "properties": { "document": { "$ref": "#/components/schemas/PolicyDocument", "description": "The document tried, the body a `PUT` of the organisation's policy would send" }, "key_id": { "description": "The key of this organisation whose requests are asked about", "maxLength": 64, "title": "Key Id", "type": "string" }, "questions": { "description": "At most 50 questions", "items": { "$ref": "#/components/schemas/PolicyQuestion" }, "maxItems": 50, "minItems": 1, "title": "Questions", "type": "array" } }, "required": [ "key_id", "questions", "document" ], "title": "PolicyDocumentDecisionsAsk", "type": "object" }, "PolicyDocumentDecisionsRead": { "description": "What a try of an inline policy document answers. It names no version: nothing is stored.", "properties": { "answers": { "description": "One per question, in the order asked", "items": { "$ref": "#/components/schemas/PolicyAnswer" }, "title": "Answers", "type": "array" }, "object": { "const": "organisation_policy.document_decisions", "default": "organisation_policy.document_decisions", "description": "The object's type", "title": "Object", "type": "string" } }, "required": [ "answers" ], "title": "PolicyDocumentDecisionsRead", "type": "object" }, "PolicyQuestion": { "additionalProperties": false, "description": "One thing a request could reach for, as a try asks about it.", "properties": { "action": { "anyOf": [ { "enum": [ "see", "use", "write", "delete" ], "type": "string" }, { "type": "null" } ], "description": "What the request does with it, for a kind that admits actions", "title": "Action" }, "attributes": { "anyOf": [ { "additionalProperties": { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "type": "array" }, "maxProperties": 32, "propertyNames": { "maxLength": 64 }, "type": "object" }, { "type": "null" } ], "description": "The person's attributes, as an assertion would carry them; null asks for a request that names nobody", "title": "Attributes" }, "kind": { "description": "The kind of thing, as a rule names it. `direct_turn` is answered by its rules alone, never by `settings.agents_required`, as no kind is", "enum": [ "model", "router", "tool", "prompt", "skill", "file", "agent", "schedule", "workflow", "knowledge_collection", "knowledge_index", "knowledge_graph", "datastore", "egress_host", "artifact_download", "share_link", "memory_write", "direct_turn", "thread", "memory_record", "knowledge_source", "stored_file", "datastore_record" ], "title": "Kind", "type": "string" }, "labels": { "description": "The labels it carries, which the caller has from the thing it shows", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "name": { "default": "", "description": "Its name; for `egress_host`, the host", "maxLength": 512, "title": "Name", "type": "string" } }, "required": [ "kind" ], "title": "PolicyQuestion", "type": "object" }, "PolicySettings": { "additionalProperties": false, "description": "What a document says that is not a rule: two demands on every request, which label values\na person may write, where data may go, how long a share link may live, what a turn on a\nretired model gets, and -- on an organisation's document alone -- the live checks every turn\nof its keys is held to.", "properties": { "agents_required": { "default": false, "description": "whether every model turn must name one of the agents the rules permit and run it as defined: a turn naming none, a turn adding tools, skills, instructions or a prompt of its own, a direct tool call and a knowledge search outside a turn are refused with 403. Either the organisation's document or the key's own may require it. Refused in a document none of whose rules permits an `agent`", "title": "Agents Required", "type": "boolean" }, "blocked_reply": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ], "description": "the standard reply a turn answers with, calling no model, when one of `live_checks` on the input fails; required when one of them blocks the input. An agent's own failed input check answers the agent's reply. On an organisation's document alone. Left out of the document, stored and answered, while it is null", "title": "Blocked Reply" }, "deprecated_models": { "anyOf": [ { "enum": [ "reroute", "block" ], "type": "string" }, { "type": "null" } ], "description": "what a turn naming a deprecated model gets from the model's effective date on: 'reroute' runs it on the model's replacement, admitted exactly as a turn naming the replacement would be; 'block' refuses it on `model`, naming the date and the replacement. Null says nothing and is the default. Block holds when any document a turn is decided under says block -- the organisation's or the key's own -- and reroute where none does. Left out of the document, stored and answered, while it is null", "title": "Deprecated Models" }, "host_regions": { "additionalProperties": { "pattern": "^(eu|us|in-cluster|global|[a-z]{2})$", "type": "string" }, "default": {}, "description": "where each permitted host is served, as the policy author's own assertion: a hostname or '*.suffix' wildcard, exactly as a rule over `egress_host` spells it, mapped to a jurisdiction ('eu', 'us', 'in-cluster', 'global') or an ISO 3166-1 alpha-2 country code ('nl'). Read only when `regions_allow` is a list: a host with no declaration is then refused rather than dialled, and one declared outside the list is refused too, unless `region_exceptions` names the host. An API connector or MCP server that carries its own `region` is judged by that region and this map together, the more cautious placement winning; this map alone places every other host -- a source with no region, a token endpoint, a run callback, an event webhook. Ignored entirely by a document that names no regions", "maxProperties": 200, "propertyNames": { "maxLength": 200, "minLength": 1 }, "title": "Host Regions", "type": "object" }, "live_checks": { "anyOf": [ { "items": { "$ref": "#/components/schemas/LiveCheck" }, "maxItems": 16, "type": "array" }, { "type": "null" } ], "description": "the live checks every turn of the organisation's keys is held to, at most 16, in the shape an agent version's checks take: plain responses, prompts, agents, routers, nested agents, background runs, workflow steps and tasks, with an agent's own checks applied beside them. Names are unique within this list; a result and `X-Core-Check` say an organisation's check from an agent's. Every judged check names its `judge_model`, a model this organisation has. Blocking checks only: a background check and an alert are not yet supported. On an organisation's document alone: a key's document holding any is refused. Not inherited by the organisations below. Null, the default, holds none; left out of the document, stored and answered, while it holds none", "title": "Live Checks" }, "pseudonymisation_floor": { "anyOf": [ { "$ref": "#/components/schemas/PseudonymisationFloor" }, { "type": "null" } ], "description": "what every key under this document that hides personal data is held to at least: edge rules and media answers in the shape of the key's own `pseudonymisation` config, which the key may tighten and never loosen. Binds the organisations below as well. Null holds nothing" }, "region_exceptions": { "default": [], "description": "named destinations a call may reach although they are served outside `regions_allow`: 'model:', 'host:' (spelled as a rule over `egress_host` spells it, a wildcard over at least two labels), 'builtin:web_fetch', 'builtin:web_search', 'builtin:computer', or 'vendor:firecrawl' (a website connector's crawl), 'vendor:llamacloud' (a llama_parse node). Read only while `regions_allow` is a list; covers a destination wherever it is served, one nobody placed included. Every strict document a call is decided under must either admit the destination's region or list it here; an exception lifts nothing else -- the rules, the deployment's block list and a turn's own hosting region all still apply -- and every call it lets through is audited 'allowed by residency exception'", "items": { "maxLength": 210, "type": "string" }, "maxItems": 200, "title": "Region Exceptions", "type": "array" }, "regions_allow": { "anyOf": [ { "items": { "pattern": "^(eu|us|in-cluster|global|[a-z]{2})$", "type": "string" }, "maxItems": 200, "minItems": 1, "type": "array" }, { "type": "null" } ], "description": "hosting regions model calls under this document may run in: a jurisdiction ('eu', 'us', 'in-cluster', 'global') or an ISO 3166-1 alpha-2 country code ('nl'). Null is the unrestricted form and the default; a list refuses every model hosted outside it -- places nest, so 'eu' contains 'in-cluster' and every member state, and 'global' contains everything -- and every model whose own hosting region is unknown, except a destination `region_exceptions` names. The same list holds every other destination a call reaches -- tool and MCP hosts, callbacks, webhooks, web vendors, computers, Firecrawl, LlamaCloud -- and the deployment's embedding model. An empty list is refused rather than read as 'no model at all'", "title": "Regions Allow" }, "share_link_max_days": { "anyOf": [ { "maximum": 365.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "the longest a share link made under this document may live, in days, from 1 to 365. Null names none and is the default. The shortest any document a link is made under names applies -- the organisation's and the key's own -- and 30 days where none names any. Read only where rules permit `share_link`. Left out of the document, stored and answered, while it is null", "title": "Share Link Max Days" }, "subjects_required": { "default": false, "description": "whether a request under this document must name a subject; a request that names none is 422 rather than a request that reaches everything", "title": "Subjects Required", "type": "boolean" }, "vendors_allow": { "anyOf": [ { "$ref": "#/components/schemas/VendorRequirement" }, { "type": "null" } ], "description": "who may serve a destination under this document: the places the company and its ultimate parent must be established in, and whether a model's weights must be open. Asked of every model, of the operator's own vendors (web tools, Firecrawl, LlamaCloud, computer pools) and of every host whose registration states who runs it (an API connector, an MCP server, an event webhook, a run's callback); a fact nobody stated counts as 'global'. Not asked of a host no registration speaks for. Null holds nothing and is the default; no residency exception lifts it. Left out of the document, stored and answered, while it is null" }, "writable_labels": { "additionalProperties": { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "const": "subject", "type": "string" }, { "$ref": "#/components/schemas/AttributeMatch" }, { "$ref": "#/components/schemas/ValueMatch" } ] } }, "type": "object" }, "default": {}, "description": "per kind of row, label names mapped to what a value written under that name must match when the request names a person: 'subject' for her own id, {'attribute': name} for one of her values for that attribute, {'value': literal} for one fixed string; every value of a list must match. A write whose new value fails is refused whole (422 on labels., or metadata. for a string the rules still read from metadata); removing a label and keeping the value a row already carries are always allowed; a name not in the map is unrestricted, and a request that names nobody is never checked", "propertyNames": { "enum": [ "thread", "memory_record", "knowledge_source", "stored_file", "datastore_record" ] }, "title": "Writable Labels", "type": "object" } }, "title": "PolicySettings", "type": "object" }, "PolicyVerdict": { "description": "One question's answer under one document.", "properties": { "allowed": { "description": "Whether the request would reach the thing", "title": "Allowed", "type": "boolean" }, "document": { "anyOf": [ { "enum": [ "ancestor", "organisation", "key", "default" ], "type": "string" }, { "type": "null" } ], "description": "Whose document decided; `ancestor` never says which", "title": "Document" }, "reason": { "description": "Why, in the words a decision records", "title": "Reason", "type": "string" }, "rule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The rule that decided, by id or position; null where nothing permitted and where an organisation above decided", "title": "Rule" } }, "required": [ "allowed", "reason", "document", "rule" ], "title": "PolicyVerdict", "type": "object" }, "PortSpec": { "additionalProperties": false, "description": "One named end of a component: what it carries, and how many edges it takes.\n\nEvery component has at most one `main` input and exactly one `main` output; an edge naming no\nport reaches the main one, so every graph drawn before ports had names still means what it\nmeant. `field`, on a port beside the main one, says the port carries one field of the\ncomponent's items rather than a payload of its own: on an output, that field of every item the\ncomponent emits; on an input, values joined onto the component's own items by key\n(`app.knowledge.pipelines.items`).", "properties": { "field": { "anyOf": [ { "enum": [ "text", "metadata" ], "type": "string" }, { "type": "null" } ], "description": "the item field this port carries on its own, joined by item key; null for a port carrying a payload of its own", "title": "Field" }, "kinds": { "description": "port kinds this port carries: an input takes any of them, an output emits exactly one", "items": { "enum": [ "raw", "documents", "chunks", "rows", "facts", "memories", "stored", "retrieval", "text", "metadata", "filters", "question", "index", "collection", "graph" ], "type": "string" }, "title": "Kinds", "type": "array" }, "label_key": { "description": "translation key an editor labels the port with", "title": "Label Key", "type": "string" }, "main": { "default": false, "description": "whether an edge that names no port reaches this one", "title": "Main", "type": "boolean" }, "multi": { "default": false, "description": "input only: whether more than one edge may feed it", "title": "Multi", "type": "boolean" }, "name": { "description": "stable port id, unique per direction per kind", "pattern": "^[a-z][a-z0-9_]{0,31}$", "title": "Name", "type": "string" }, "required": { "default": false, "description": "input only: a pipeline is refused while nothing feeds it", "title": "Required", "type": "boolean" } }, "required": [ "name", "kinds", "label_key" ], "title": "PortSpec", "type": "object" }, "ProblemReason": { "description": "why a request was refused, where one status answers for more than one reason. A value may be added: treat one you do not know as a plain problem of its status", "enum": [ "stale_version", "organisation_suspended", "service_account_paused", "key_in_browser", "computer_not_configured" ], "title": "ProblemReason", "type": "string" }, "ProductEventAbout": { "additionalProperties": false, "description": "What the event was about, stored as `refs.about = \":\"`.", "properties": { "id": { "description": "The product's own id of that thing; no name, no text", "pattern": "^[A-Za-z0-9_.:-]{1,128}$", "title": "Id", "type": "string" }, "kind": { "description": "The kind of thing in the product's own words, lower case: `role`, `export`", "pattern": "^[a-z][a-z0-9_]{0,31}$", "title": "Kind", "type": "string" } }, "required": [ "kind", "id" ], "title": "ProductEventAbout", "type": "object" }, "ProductEventAccepted": { "description": "What became of one delivered event. Not a `Read` of a resource: the row itself is read on\n`GET /audit/events`.", "properties": { "audit_event_id": { "description": "The audit event that records it", "title": "Audit Event Id", "type": "string" }, "created": { "description": "False when this id was delivered before; the earlier row stands unchanged", "title": "Created", "type": "boolean" }, "id": { "description": "The product's own id for the event, as delivered", "title": "Id", "type": "string" } }, "required": [ "id", "audit_event_id", "created" ], "title": "ProductEventAccepted", "type": "object" }, "ProductEventCreate": { "additionalProperties": false, "description": "One event only the product knows of.", "properties": { "about": { "$ref": "#/components/schemas/ProductEventAbout", "description": "What the event was about" }, "actor": { "anyOf": [ { "pattern": "^[A-Za-z0-9_-]{1,64}$", "type": "string" }, { "type": "null" } ], "description": "The product's own opaque id of whoever acted, stored as `:`; the namespace alone when absent", "title": "Actor" }, "changes": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object" }, { "type": "null" } ], "description": "The fields that changed: at most 32 keys, each a scalar, a list of at most 16 scalars or `{from, to}`, 2 KiB in all. No secret, no content, no e-mail address", "title": "Changes" }, "event": { "description": "The event name, in the delivering key's namespace and at least two segments after it: `acme.role.assigned`", "maxLength": 64, "pattern": "^[a-z][a-z0-9]{1,15}(\\.[a-z][a-z0-9_]*){2,}$", "title": "Event", "type": "string" }, "id": { "description": "The product's own id for this event. Delivering it again keeps the row already recorded and answers `created: false`, whatever the second delivery says", "pattern": "^[A-Za-z0-9_-]{1,64}$", "title": "Id", "type": "string" }, "occurred_at": { "description": "When it happened, with a timezone; at most five minutes ahead of Core's clock and inside the organisation's audit retention window", "format": "date-time", "title": "Occurred At", "type": "string" }, "request_id": { "anyOf": [ { "pattern": "^req_[0-9A-HJKMNP-TV-Z]{26}$", "type": "string" }, { "type": "null" } ], "description": "The id Core gave the call this event belongs to, so `?request_id=` finds both; this delivery's own request id when absent. Recorded as the product's word, not checked against the trail", "title": "Request Id" }, "subject": { "anyOf": [ { "pattern": "^[A-Za-z0-9._:@-]{1,128}$", "type": "string" }, { "type": "null" } ], "description": "The person it happened for, by the id the calling application names them with on every other route; stored as the row's `subject_id`", "title": "Subject" } }, "required": [ "id", "event", "occurred_at", "about" ], "title": "ProductEventCreate", "type": "object" }, "ProductEventsAccepted": { "description": "Answer to `POST /audit/events`, one item per delivered event in the order sent.", "properties": { "items": { "description": "One per event, in request order", "items": { "$ref": "#/components/schemas/ProductEventAccepted" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "ProductEventsAccepted", "type": "object" }, "ProductEventsConfig": { "additionalProperties": false, "description": "The `product_events` capability: this key delivers the events of a product built on Core to\nits organisation's audit trail (`docs/architecture/audit-and-metering.md#product-events`).\n\nNo configuration and no dependency. Which product it delivers for is the operator's\n`product_namespace` on the organisation, never the key's; reading the trail needs nothing.", "properties": {}, "title": "ProductEventsConfig", "type": "object" }, "ProductEventsCreate": { "additionalProperties": false, "description": "Body of `POST /audit/events`: checked whole before any event is recorded.", "properties": { "events": { "description": "One to a hundred events, recorded together or not at all", "items": { "$ref": "#/components/schemas/ProductEventCreate" }, "maxItems": 100, "minItems": 1, "title": "Events", "type": "array" } }, "required": [ "events" ], "title": "ProductEventsCreate", "type": "object" }, "PromotionSettings": { "additionalProperties": false, "description": "Whether the improvement analyses may propose a personal record of this store as a shared\none (`docs/architecture/knowledge-and-memory.md#promotion`). Off by default: a reading is a\nmetered model call.", "properties": { "apply_without_review": { "default": "inherit", "description": "whether a promotion proposal for this store is applied with nobody reviewing it: `inherit` takes the organisation's `apply_level` for `memory_shared_fact`; `on` (`publish`) and `off` (`propose`) win over it", "enum": [ "inherit", "on", "off" ], "title": "Apply Without Review", "type": "string" }, "enabled": { "default": false, "description": "whether the analyses read this store's personal records for a fact that is the organisation's; off by default, since the reading is a metered model call", "title": "Enabled", "type": "boolean" }, "labels": { "description": "metadata a proposed shared record starts with, such as `audience: everyone`; the person applying it may change it", "maxProperties": 16, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "maxLength": 512, "type": "string" } }, "title": "Labels", "type": "object" }, "min_people": { "default": 3, "description": "how many different people must hold the same fact before it is proposed as the organisation's", "maximum": 20.0, "minimum": 2.0, "title": "Min People", "type": "integer" }, "types": { "description": "the record types read for promotion; never `preference`, `commitment`, `episode`, `lesson` or `behaviour`, which are about one person by nature", "items": { "type": "string" }, "maxItems": 16, "minItems": 1, "title": "Types", "type": "array" } }, "title": "PromotionSettings", "type": "object" }, "PromptCopyCreate": { "additionalProperties": false, "description": "Body of `POST /prompts/{prompt_id}/copy` and its twin: creates a new prompt from one\npublished version of another. Its own model, since it carries a name and a version rather\nthan a template (`docs/architecture/versions-and-drafts.md#copying`).", "properties": { "name": { "description": "The new object's name, unique within the organisation and held to the kind's own naming rule, exactly as a create's name is", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "title": "Name", "type": "string" }, "version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "The published version to copy; absent copies the latest published version. A draft is never copied, and naming one answers as a version that was never written does", "title": "Version" } }, "required": [ "name" ], "title": "PromptCopyCreate", "type": "object" }, "PromptCreate": { "additionalProperties": false, "description": "Body of `POST /prompts`: creates the prompt and its first version (1) together.", "properties": { "input_schema": { "$ref": "#/components/schemas/InputSchema", "description": "The variables a caller fills in, as one JSON Schema object: a property per `{{ name }}` placeholder, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum`, and one fallback, `default` or `x-builtin`; `required` names the variables a render must be given. Every placeholder the template uses must be declared, and every declared property used. A render holds each value to its property and inserts it as text, as an untrusted segment" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/InstallValue" }, "description": "A typed value for every `{{ $name }}` in the template, by name: `{type, value, allowed, description}`, a `string`, `number` or `enum` as a shared bundle's parameters are. Its text is filled in before the template is read, as the author's own text at the template's trust -- never an untrusted argument. Every `{{ $name }}` needs a value and every value must be used; a name may not also be a variable, and a value may not contain `{{` or `}}`. A copy a publication installed carries the installer's values already written into its template, and `{}` here", "maxProperties": 64, "title": "Install Values", "type": "object" }, "labels": { "default": {}, "description": "The organisation's classification of this prompt, as label -> value; what the rules over `prompt` read", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "additionalProperties": true, "description": "an opaque document a caller attaches to the prompt, at most 16 KiB serialised: stored, returned and never read by Core", "title": "Metadata", "type": "object" }, "name": { "description": "Unique name within the tenant, used to invoke it", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "title": "Name", "type": "string" }, "role": { "default": "developer", "description": "Authority the rendered item carries", "enum": [ "developer", "delegate" ], "title": "Role", "type": "string" }, "template": { "description": "The template text, at most 262144 characters; `{{ name }}` marks a placeholder", "maxLength": 262144, "title": "Template", "type": "string" } }, "required": [ "name", "template" ], "title": "PromptCreate", "type": "object" }, "PromptRead": { "description": "A prompt, as the API returns it: its identity plus its latest version in full -- never\njust a version number, so a caller reading one prompt always sees what it currently says.\n\n`origin` says where the row came from when a subscription installed it, so a console can say\n\"shared by *X*\" without a second call (`app.definitions.origin`).", "properties": { "created_at": { "description": "When the prompt was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created the prompt: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "id": { "description": "Prompt id", "title": "Id", "type": "string" }, "labels": { "default": {}, "description": "The organisation's classification of this prompt, as label -> value", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "latest_version": { "$ref": "#/components/schemas/PromptVersionRead", "description": "The highest published version; on the management twin, the newest draft while the prompt has no published version" }, "metadata": { "additionalProperties": true, "default": {}, "description": "The opaque document attached to this prompt; {} when none was set", "title": "Metadata", "type": "object" }, "name": { "description": "Unique name within the tenant, used to invoke it", "title": "Name", "type": "string" }, "object": { "const": "prompt", "default": "prompt", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/OriginRead" }, { "type": "null" } ], "description": "The subscription that installed this prompt, and the publication it came from; null for a prompt this organisation wrote itself" }, "updated_at": { "description": "When the prompt last gained a new version", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "name", "latest_version", "created_by", "created_at", "updated_at" ], "title": "PromptRead", "type": "object" }, "PromptRef": { "additionalProperties": false, "description": "A stored prompt to render as this turn's input.", "properties": { "id": { "description": "the prompt's name or prm_ id", "title": "Id", "type": "string" }, "variables": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "default": {}, "description": "values substituted into the prompt, by variable name: each one JSON scalar its property in the prompt's `input_schema` admits, inserted as text", "title": "Variables", "type": "object" }, "version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "pinned prompt version; latest when unset", "title": "Version" } }, "required": [ "id" ], "title": "PromptRef", "type": "object" }, "PromptVersionCreate": { "additionalProperties": false, "description": "Body of `POST /prompts/{prompt_id}/versions`: adds a new version to an existing prompt.", "properties": { "input_schema": { "$ref": "#/components/schemas/InputSchema", "description": "The variables a caller fills in, as one JSON Schema object: a property per `{{ name }}` placeholder, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum`, and one fallback, `default` or `x-builtin`; `required` names the variables a render must be given. Every placeholder the template uses must be declared, and every declared property used. A render holds each value to its property and inserts it as text, as an untrusted segment" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/InstallValue" }, "description": "A typed value for every `{{ $name }}` in the template, by name: `{type, value, allowed, description}`, a `string`, `number` or `enum` as a shared bundle's parameters are. Its text is filled in before the template is read, as the author's own text at the template's trust -- never an untrusted argument. Every `{{ $name }}` needs a value and every value must be used; a name may not also be a variable, and a value may not contain `{{` or `}}`. A copy a publication installed carries the installer's values already written into its template, and `{}` here", "maxProperties": 64, "title": "Install Values", "type": "object" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "The prompt's classification, replaced wholesale as this version lands; absent leaves it as it is, and {} clears it. A prompt has no other update route -- a new version is how one changes", "title": "Labels" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "an opaque document a caller attaches to the prompt, at most 16 KiB serialised: stored, returned and never read by Core; absent leaves it as it is, and {} clears it. A prompt has no other update route -- a new version is how one changes", "title": "Metadata" }, "role": { "default": "developer", "description": "Authority the rendered item carries", "enum": [ "developer", "delegate" ], "title": "Role", "type": "string" }, "template": { "description": "The template text, at most 262144 characters; `{{ name }}` marks a placeholder", "maxLength": 262144, "title": "Template", "type": "string" } }, "required": [ "template" ], "title": "PromptVersionCreate", "type": "object" }, "PromptVersionRead": { "description": "One immutable prompt version, as the API returns it.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "created_at": { "description": "When this version was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created the version: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "id": { "description": "Prompt version id", "title": "Id", "type": "string" }, "input_schema": { "$ref": "#/components/schemas/InputSchema", "description": "The variables a caller fills in, as one JSON Schema object: a property per `{{ name }}` placeholder, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum`, and one fallback, `default` or `x-builtin`; `required` names the variables a render must be given. Every placeholder the template uses must be declared, and every declared property used. A render holds each value to its property and inserts it as text, as an untrusted segment; no properties for a sealed copy" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/InstallValue" }, "description": "A typed value for every `{{ $name }}` in the template, by name: `{type, value, allowed, description}`, a `string`, `number` or `enum` as a shared bundle's parameters are. Its text is filled in before the template is read, as the author's own text at the template's trust -- never an untrusted argument. Every `{{ $name }}` needs a value and every value must be used; a name may not also be a variable, and a value may not contain `{{` or `}}`. A copy a publication installed carries the installer's values already written into its template, and `{}` here; empty for a sealed copy", "title": "Install Values", "type": "object" }, "object": { "const": "prompt_version", "default": "prompt_version", "description": "The object's type", "title": "Object", "type": "string" }, "prompt_id": { "description": "Owning prompt id", "title": "Prompt Id", "type": "string" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "role": { "description": "Authority the rendered item carries", "enum": [ "developer", "delegate" ], "title": "Role", "type": "string" }, "sealed": { "default": false, "description": "Whether this version was installed under sealed terms, so its content is withheld here for good -- whatever a later version of the same copy says, and after a fork. A version this organisation wrote itself is never sealed", "title": "Sealed", "type": "boolean" }, "state": { "default": "published", "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "template": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The template text; null when the publication that shared this prompt withholds its content ('sealed'), which a turn still renders unchanged", "title": "Template" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" } }, "required": [ "id", "prompt_id", "version", "template", "input_schema", "role", "created_by", "acted_for", "created_at" ], "title": "PromptVersionRead", "type": "object" }, "PromptsConfig": { "additionalProperties": false, "description": "The `prompts` capability. No configuration yet.", "properties": {}, "title": "PromptsConfig", "type": "object" }, "ProposalApply": { "additionalProperties": false, "description": "What applying a proposal may carry: the caller's own change in place of the drafted one.", "properties": { "change": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "A change of the proposal's own kind, written in place of the drafted one and validated the same way; how a person removes a placeholder or rewrites a sentence before applying. Null applies the drafted change", "title": "Change" } }, "title": "ProposalApply", "type": "object" }, "ProposalDetailRead": { "description": "One proposal with the turns it rests on, at most twenty.", "properties": { "applied_ref": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "What applying it created: `kind`, `id`, `version`, and `draft: true` when that version is a draft no key runs until a person publishes it", "title": "Applied Ref" }, "auto_apply_refused": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why an analysis could not apply it without review, as a code such as has_placeholders, target_changed or policy_denied; it then waits for a person. Null when no analysis tried or one applied it", "title": "Auto Apply Refused" }, "change": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The drafted change, in its kind's shape; null when the proposal carries figures and no drafted change", "title": "Change" }, "check": { "description": "The check that found it", "title": "Check", "type": "string" }, "created_at": { "description": "When it was first written", "format": "date-time", "title": "Created At", "type": "string" }, "decided_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When a person, a key or an analysis applying it without review last moved it", "title": "Decided At" }, "decided_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Key id, operator:, or auto for an analysis applying it without review, that last moved it", "title": "Decided By" }, "evidence": { "description": "The turns, or memory records, the finding rests on, newest first", "items": { "$ref": "#/components/schemas/EvidenceRead" }, "title": "Evidence", "type": "array" }, "figures": { "additionalProperties": true, "description": "The numbers behind the finding", "title": "Figures", "type": "object" }, "first_analysis_id": { "description": "The analysis that first found it", "title": "First Analysis Id", "type": "string" }, "has_placeholders": { "description": "Whether the drafted change holds a placeholder the pseudonymisation left", "title": "Has Placeholders", "type": "boolean" }, "id": { "description": "Proposal id", "title": "Id", "type": "string" }, "kind": { "description": "The proposal kind, which decides what `change` holds", "title": "Kind", "type": "string" }, "last_seen_analysis_id": { "description": "The analysis that last found it", "title": "Last Seen Analysis Id", "type": "string" }, "last_seen_at": { "description": "When an analysis last found it", "format": "date-time", "title": "Last Seen At", "type": "string" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "What the person who moved it wrote", "title": "Note" }, "object": { "const": "improvement_proposal", "default": "improvement_proposal", "description": "The object's type", "title": "Object", "type": "string" }, "rationale": { "description": "Why, when a model read the conversations; else empty", "title": "Rationale", "type": "string" }, "status": { "description": "Where the proposal stands", "enum": [ "open", "accepted", "dismissed", "applied", "resolved" ], "title": "Status", "type": "string" }, "summary": { "description": "A short summary", "title": "Summary", "type": "string" }, "target_id": { "description": "The target's id", "title": "Target Id", "type": "string" }, "target_kind": { "description": "What it is about: agent, prompt, skill or a later kind", "title": "Target Kind", "type": "string" }, "target_name": { "description": "The target's name when it was found", "title": "Target Name", "type": "string" }, "target_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The version the finding is about", "title": "Target Version" }, "title": { "description": "One line", "title": "Title", "type": "string" } }, "required": [ "id", "check", "kind", "target_kind", "target_id", "target_name", "target_version", "status", "title", "summary", "rationale", "change", "has_placeholders", "figures", "first_analysis_id", "last_seen_analysis_id", "last_seen_at", "decided_by", "auto_apply_refused", "decided_at", "note", "applied_ref", "created_at", "evidence" ], "title": "ProposalDetailRead", "type": "object" }, "ProposalRead": { "description": "One finding of an analysis, and where a person moved it.", "properties": { "applied_ref": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "What applying it created: `kind`, `id`, `version`, and `draft: true` when that version is a draft no key runs until a person publishes it", "title": "Applied Ref" }, "auto_apply_refused": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why an analysis could not apply it without review, as a code such as has_placeholders, target_changed or policy_denied; it then waits for a person. Null when no analysis tried or one applied it", "title": "Auto Apply Refused" }, "change": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The drafted change, in its kind's shape; null when the proposal carries figures and no drafted change", "title": "Change" }, "check": { "description": "The check that found it", "title": "Check", "type": "string" }, "created_at": { "description": "When it was first written", "format": "date-time", "title": "Created At", "type": "string" }, "decided_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When a person, a key or an analysis applying it without review last moved it", "title": "Decided At" }, "decided_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Key id, operator:, or auto for an analysis applying it without review, that last moved it", "title": "Decided By" }, "figures": { "additionalProperties": true, "description": "The numbers behind the finding", "title": "Figures", "type": "object" }, "first_analysis_id": { "description": "The analysis that first found it", "title": "First Analysis Id", "type": "string" }, "has_placeholders": { "description": "Whether the drafted change holds a placeholder the pseudonymisation left", "title": "Has Placeholders", "type": "boolean" }, "id": { "description": "Proposal id", "title": "Id", "type": "string" }, "kind": { "description": "The proposal kind, which decides what `change` holds", "title": "Kind", "type": "string" }, "last_seen_analysis_id": { "description": "The analysis that last found it", "title": "Last Seen Analysis Id", "type": "string" }, "last_seen_at": { "description": "When an analysis last found it", "format": "date-time", "title": "Last Seen At", "type": "string" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "What the person who moved it wrote", "title": "Note" }, "object": { "const": "improvement_proposal", "default": "improvement_proposal", "description": "The object's type", "title": "Object", "type": "string" }, "rationale": { "description": "Why, when a model read the conversations; else empty", "title": "Rationale", "type": "string" }, "status": { "description": "Where the proposal stands", "enum": [ "open", "accepted", "dismissed", "applied", "resolved" ], "title": "Status", "type": "string" }, "summary": { "description": "A short summary", "title": "Summary", "type": "string" }, "target_id": { "description": "The target's id", "title": "Target Id", "type": "string" }, "target_kind": { "description": "What it is about: agent, prompt, skill or a later kind", "title": "Target Kind", "type": "string" }, "target_name": { "description": "The target's name when it was found", "title": "Target Name", "type": "string" }, "target_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The version the finding is about", "title": "Target Version" }, "title": { "description": "One line", "title": "Title", "type": "string" } }, "required": [ "id", "check", "kind", "target_kind", "target_id", "target_name", "target_version", "status", "title", "summary", "rationale", "change", "has_placeholders", "figures", "first_analysis_id", "last_seen_analysis_id", "last_seen_at", "decided_by", "auto_apply_refused", "decided_at", "note", "applied_ref", "created_at" ], "title": "ProposalRead", "type": "object" }, "ProposalUpdate": { "additionalProperties": false, "description": "A move of a proposal by hand, per the transitions table.", "properties": { "note": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ], "description": "Why, in the mover's own words", "title": "Note" }, "status": { "description": "Where the proposal moves to", "enum": [ "open", "accepted", "dismissed", "applied" ], "title": "Status", "type": "string" } }, "required": [ "status" ], "title": "ProposalUpdate", "type": "object" }, "ProvenanceEntryRead": { "additionalProperties": false, "description": "One source item that fed a derived record, as the API returns it.\n\nThe stored entry also carries that item's own trust label\n(`app.turns.items.ProvenanceEntry`); this read model does not, like every other read\nmodel Core answers.", "properties": { "item_id": { "description": "id of the source item", "title": "Item Id", "type": "string" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "thread the source item belongs to, when persisted", "title": "Thread Id" } }, "required": [ "item_id" ], "title": "ProvenanceEntryRead", "type": "object" }, "ProvenanceRead": { "additionalProperties": false, "description": "The chain of source items behind a derived record, and the model that derived it.", "properties": { "items": { "description": "every source item, in order", "items": { "$ref": "#/components/schemas/ProvenanceEntryRead" }, "title": "Items", "type": "array" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "id of the model that produced the derived content, if any", "title": "Model" } }, "required": [ "items" ], "title": "ProvenanceRead", "type": "object" }, "PseudonymRead": { "description": "One value a thread hid and the placeholder it hid it under.\n\n`value` is the caller's own personal data, returned only to the key whose tenant owns the\nthread -- the same key that sent it in the first place (`docs/architecture/threads.md`).", "properties": { "created_at": { "description": "When this value was first hidden", "format": "date-time", "title": "Created At", "type": "string" }, "entity": { "description": "The entity type the detector found here", "title": "Entity", "type": "string" }, "id": { "description": "Pseudonym id", "title": "Id", "type": "string" }, "object": { "const": "pseudonym", "default": "pseudonym", "description": "The object's type", "title": "Object", "type": "string" }, "placeholder": { "description": "The token the model saw in place of the value", "title": "Placeholder", "type": "string" }, "suppressed": { "description": "Whether this value is left in clear from now on", "title": "Suppressed", "type": "boolean" }, "value": { "description": "The text the placeholder stands for", "title": "Value", "type": "string" } }, "required": [ "id", "entity", "placeholder", "value", "suppressed", "created_at" ], "title": "PseudonymRead", "type": "object" }, "PseudonymSpan": { "description": "One placeholder standing in a context element, and never what it stands for.", "properties": { "element": { "description": "index of the context element this span is in", "title": "Element", "type": "integer" }, "end": { "description": "offset just past the placeholder in the element's text", "title": "End", "type": "integer" }, "entity": { "description": "the kind of thing it stands for, e.g. PERSON", "title": "Entity", "type": "string" }, "placeholder": { "description": "the placeholder as the model read it, e.g. ", "title": "Placeholder", "type": "string" }, "start": { "description": "offset of the placeholder in the element's text", "title": "Start", "type": "integer" } }, "required": [ "element", "placeholder", "entity", "start", "end" ], "title": "PseudonymSpan", "type": "object" }, "PseudonymisationConfig": { "additionalProperties": false, "description": "The `pseudonymisation` capability: the detection settings, and what each edge that leaves\nCore is sent (`docs/architecture/pseudonymisation-edges.md`).", "properties": { "edges": { "default": [], "description": "what each tool that reaches another party is sent, the most specific rule deciding; an edge no rule names keeps its default: the web tools, the image tools and a transcription tool's prompt hide again what the turn hid, every other edge is sent in clear. An organisation's floor may tighten a rule and never loosen it", "items": { "$ref": "#/components/schemas/EdgeRule" }, "maxItems": 200, "title": "Edges", "type": "array" }, "entities": { "default": [ "PERSON", "EMAIL_ADDRESS", "PHONE_NUMBER", "IBAN_CODE", "CREDIT_CARD", "NL_BSN" ], "description": "entity types hidden from the model, at least one; LOCATION is opt-in", "items": { "enum": [ "PERSON", "LOCATION", "EMAIL_ADDRESS", "PHONE_NUMBER", "IBAN_CODE", "CREDIT_CARD", "IP_ADDRESS", "NL_BSN", "DE_TAX_ID", "ES_NIF", "ES_NIE" ], "type": "string" }, "title": "Entities", "type": "array" }, "language": { "default": "nl", "description": "language every text on this key's turns is analysed as", "enum": [ "nl", "en", "de", "fr", "es" ], "title": "Language", "type": "string" }, "media": { "$ref": "#/components/schemas/MediaRules", "default": { "audio": "allow", "images": "allow", "speech": "refuse" }, "description": "what is sent of each class of media, which no placeholder can stand in for" }, "score_threshold": { "default": 0.5, "description": "minimum detector confidence for a span to be hidden", "maximum": 1, "minimum": 0, "title": "Score Threshold", "type": "number" } }, "title": "PseudonymisationConfig", "type": "object" }, "PseudonymisationFloor": { "additionalProperties": false, "description": "What every hiding key under a document is held to at least, edge by edge.", "properties": { "edges": { "default": [], "description": "rules a key's own may tighten and never loosen, argument by argument", "items": { "$ref": "#/components/schemas/EdgeRule" }, "maxItems": 200, "title": "Edges", "type": "array" }, "media": { "$ref": "#/components/schemas/MediaFloor", "default": {}, "description": "the least each class of media is held to" } }, "title": "PseudonymisationFloor", "type": "object" }, "PublicationConnectorConfig": { "additionalProperties": false, "description": "Another tenant's collection, reached through a publication this organisation subscribes to.\n\nThe one connector kind whose origin is inside this deployment rather than outside it, and the\none **no caller may configure**: a subscription's sync writes it when it installs a\n`collection` member, naming the publication and the member, and `PUT`/`PATCH` refuse the kind\noutright (`app.knowledge.connector_service`). Were it writable, a caller could point its own\ncollection at any publication id it could guess and read a bundle it never subscribed to.\n\nThere is no credential and there is no URL. What the provider may read is decided entirely by\nthe subscription: the publisher, the member, and the publisher's own sources -- resolved\ninside the worker on a session built for the publisher's placement, never on a request\n(`app.knowledge.connectors.providers.publication`).", "properties": { "exclude_path_regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Items whose path matches this are skipped, on top of the built-in media/binary exclusion, which always applies and is never replaced", "title": "Exclude Path Regex" }, "include_path_regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Only items whose path matches this are synced; null matches all", "title": "Include Path Regex" }, "kind": { "const": "publication", "description": "Connector kind", "title": "Kind", "type": "string" }, "member": { "description": "The collection member of that publication's manifest this copy follows", "maxLength": 64, "minLength": 1, "title": "Member", "type": "string" }, "publication_id": { "description": "The publication whose member this copy follows", "maxLength": 64, "minLength": 1, "title": "Publication Id", "type": "string" }, "subscription_id": { "description": "The subscription that installed this copy, so the provider can refuse a publication this organisation no longer subscribes to", "maxLength": 64, "minLength": 1, "title": "Subscription Id", "type": "string" } }, "required": [ "kind", "publication_id", "member", "subscription_id" ], "title": "PublicationConnectorConfig", "type": "object" }, "PublicationCreate": { "additionalProperties": false, "description": "Body of `POST /tenants/{tenant_id}/publications`.", "properties": { "auto_install": { "default": false, "description": "Whether every organisation created under this one subscribes at provisioning; only a 'subtree' publication may", "title": "Auto Install", "type": "boolean" }, "description": { "default": "", "description": "What this bundle is for", "maxLength": 1024, "title": "Description", "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the publication, at most 16 KiB serialised: stored, returned and never read by Core; omitted or null stores {}", "title": "Metadata" }, "name": { "description": "Name, unique within this publisher", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "title": "Name", "type": "string" }, "status": { "default": "draft", "description": "'draft' while it is being built; 'listed' once it may be subscribed to. A catalogue publication may only be created 'draft': an operator lists it", "enum": [ "draft", "listed" ], "title": "Status", "type": "string" }, "targets": { "description": "Organisation ids that may subscribe; required and non-empty for 'tenants', and must be empty for 'subtree'", "items": { "type": "string" }, "maxItems": 256, "title": "Targets", "type": "array" }, "visibility": { "description": "'subtree' -- every organisation below this one -- 'tenants', which names them one by one, or 'catalogue', the deployment's marketplace", "enum": [ "subtree", "tenants", "catalogue" ], "title": "Visibility", "type": "string" } }, "required": [ "name", "visibility" ], "title": "PublicationCreate", "type": "object" }, "PublicationFileRead": { "description": "A file a publication holds, without its bytes.", "properties": { "created_at": { "description": "When the publication first held these bytes", "format": "date-time", "title": "Created At", "type": "string" }, "object": { "const": "publication_file", "default": "publication_file", "description": "The object's type", "title": "Object", "type": "string" }, "sha256": { "description": "SHA-256 hex digest of the file's bytes", "title": "Sha256", "type": "string" }, "size_bytes": { "description": "The file's length in bytes", "title": "Size Bytes", "type": "integer" } }, "required": [ "sha256", "size_bytes", "created_at" ], "title": "PublicationFileRead", "type": "object" }, "PublicationRead": { "description": "A publication, as the API returns it.", "properties": { "auto_install": { "description": "Whether every organisation created under the publisher subscribes at provisioning", "title": "Auto Install", "type": "boolean" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/CoverRead" }, { "type": "null" } ], "description": "The listing cover this publisher put on the bundle, or null when it has none; the image itself is read from this publication's own `.../cover` route, or from `/catalogue/{id}/cover` by an organisation that does not own it" }, "created_at": { "description": "When the publication was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created it: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "description": { "description": "What this bundle is for", "title": "Description", "type": "string" }, "highest_version": { "description": "The version last published, listed or not; higher than latest_version while a catalogue publication's newest version is waiting to be reviewed", "title": "Highest Version", "type": "integer" }, "id": { "description": "Publication id", "title": "Id", "type": "string" }, "latest_version": { "description": "The version a subscription following 'latest' installs; 0 before the first, and on a catalogue publication it only moves when an operator lists the version", "title": "Latest Version", "type": "integer" }, "metadata": { "additionalProperties": true, "description": "The opaque document attached to this publication; {} when none was set", "title": "Metadata", "type": "object" }, "name": { "description": "Name, unique within this publisher", "title": "Name", "type": "string" }, "object": { "const": "publication", "default": "publication", "description": "The object's type", "title": "Object", "type": "string" }, "parameter_count": { "default": 0, "description": "How many parameters the latest_version declares -- the version a subscription following 'latest' would install; 0 before the first", "title": "Parameter Count", "type": "integer" }, "pending_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description the publisher asked for on a listed catalogue publication, which replaces `description` when an operator next lists a version; null when none waits, and always null for anybody but the publisher and an operator", "title": "Pending Description" }, "required_parameter_count": { "default": 0, "description": "Of those, how many are required; 0 before the first version", "title": "Required Parameter Count", "type": "integer" }, "status": { "description": "'draft', 'submitted' (awaiting an operator's review), 'listed' or 'withdrawn'", "enum": [ "draft", "submitted", "listed", "withdrawn" ], "title": "Status", "type": "string" }, "targets": { "description": "Organisation ids that may subscribe, for 'tenants'", "items": { "type": "string" }, "title": "Targets", "type": "array" }, "tenant_id": { "description": "The publishing organisation", "title": "Tenant Id", "type": "string" }, "updated_at": { "description": "When the publication last changed", "format": "date-time", "title": "Updated At", "type": "string" }, "visibility": { "description": "Who may see and subscribe to it", "enum": [ "subtree", "tenants", "catalogue" ], "title": "Visibility", "type": "string" } }, "required": [ "id", "tenant_id", "name", "description", "visibility", "targets", "auto_install", "status", "latest_version", "highest_version", "created_by", "created_at", "updated_at", "metadata" ], "title": "PublicationRead", "type": "object" }, "PublicationUpdate": { "additionalProperties": false, "description": "Body of `PATCH .../publications/{id}`. Only the description changes: the name and the\nvisibility are what subscribers and the catalogue know the publication by, so a body naming\neither is `422`. Omitted, the description is left as it is.", "properties": { "description": { "default": "", "description": "What this bundle is for; left as it is when the field is omitted. On a listed catalogue publication it waits for the operator's next listing of a version and shows as `pending_description` until then; the name and the visibility stay fixed", "maxLength": 1024, "title": "Description", "type": "string" } }, "title": "PublicationUpdate", "type": "object" }, "PublicationVersionCheck": { "additionalProperties": false, "description": "What a publish of the same body would store, answered without publishing it.", "properties": { "capabilities": { "description": "The capabilities a subscriber's organisation must be permitted to install it", "items": { "type": "string" }, "title": "Capabilities", "type": "array" }, "manifest": { "additionalProperties": true, "description": "The canonical manifest the version would store, exported from the members when the body named rows", "title": "Manifest", "type": "object" }, "version": { "description": "The number a publish would take now; informational, since another publish may take it first", "title": "Version", "type": "integer" } }, "required": [ "manifest", "capabilities", "version" ], "title": "PublicationVersionCheck", "type": "object" }, "PublicationVersionCreate": { "additionalProperties": false, "description": "Body of `POST /tenants/{tenant_id}/publications/{id}/versions`.\n\nTwo ways to say the same thing, and exactly one of them per request: `members` names rows of\nthe publisher's own library and Core builds the manifest from them, resolving the references\nbetween the chosen rows into `$member`; `manifest` hands one over whole, which is how a\nbundle written elsewhere -- or read back from `GET .../versions/{v}` -- is published again.\nBoth are validated identically.", "properties": { "changelog": { "default": "", "description": "What changed, for whoever accepts this version", "maxLength": 4096, "title": "Changelog", "type": "string" }, "manifest": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "A whole manifest document; omit when naming members instead", "title": "Manifest" }, "members": { "description": "Rows of this organisation's own library to export; omit when sending a whole manifest", "items": { "$ref": "#/components/schemas/MemberSelector" }, "maxItems": 256, "title": "Members", "type": "array" }, "parameters": { "additionalProperties": { "$ref": "#/components/schemas/ParameterSpec" }, "description": "Typed parameters the exported members reference, for the `members` form", "title": "Parameters", "type": "object" }, "policy": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "A policy document, `rules` and `settings`, to recommend for a key that will use this bundle, for the `members` form; reported by the install report and never applied by Core", "title": "Policy" }, "requires": { "$ref": "#/components/schemas/Requires", "description": "What a subscriber needs, for the `members` form" }, "terms": { "$ref": "#/components/schemas/Terms", "description": "What a subscriber may do with this version" } }, "title": "PublicationVersionCreate", "type": "object" }, "PublicationVersionRead": { "description": "One published version: the manifest it offers and the terms it offers it under.", "properties": { "changelog": { "description": "What changed in this version", "title": "Changelog", "type": "string" }, "created_at": { "description": "When this version was published", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who published it: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "id": { "description": "Publication version id", "title": "Id", "type": "string" }, "manifest": { "additionalProperties": true, "description": "The manifest this version offers; portable by design", "title": "Manifest", "type": "object" }, "object": { "const": "publication.version", "default": "publication.version", "description": "The object's type", "title": "Object", "type": "string" }, "publication_id": { "description": "Publication this version belongs to", "title": "Publication Id", "type": "string" }, "terms": { "$ref": "#/components/schemas/Terms", "description": "What a subscriber may do with it" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" } }, "required": [ "id", "publication_id", "version", "manifest", "terms", "changelog", "created_by", "created_at" ], "title": "PublicationVersionRead", "type": "object" }, "QueueRunsRequest": { "additionalProperties": false, "description": "Body of `POST /evaluations/{id}/runs`: which agent to measure, or all of them.", "properties": { "agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the linked agent to measure; null queues one run per linked agent", "title": "Agent Id" } }, "title": "QueueRunsRequest", "type": "object" }, "ReadyRead": { "description": "The readiness payload: the database answered.", "properties": { "status": { "const": "ok", "description": "always \"ok\"; a failed check raises instead", "title": "Status", "type": "string" } }, "required": [ "status" ], "title": "ReadyRead", "type": "object" }, "ReasoningInput": { "additionalProperties": false, "description": "A `reasoning` item replayed on the request: what Core answered with, sent back unchanged.\n\nEvery field is accepted and the item is dropped when the input is mapped. Core keeps its own\nsigned thinking on the stored reasoning item and replays that, so a client's copy -- which\ncarries only the summary Core chose to show -- would be a second, weaker source for the same\nthing.", "properties": { "content": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "the reasoning text; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Content" }, "encrypted_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "an opaque reasoning payload; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Encrypted Content" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the item's id; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the item's status; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Status" }, "summary": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "the reasoning summary; accepted and ignored: it describes an item Core answered earlier rather than asking for behaviour, so a client can send `response.output` back as `input` unchanged", "title": "Summary" }, "type": { "const": "reasoning", "default": "reasoning", "description": "input item kind", "title": "Type", "type": "string" } }, "title": "ReasoningInput", "type": "object" }, "ReasoningOutput": { "additionalProperties": false, "description": "The model's reasoning summary for one round.", "properties": { "id": { "description": "the item's id", "title": "Id", "type": "string" }, "summary": { "description": "the model's reasoning summary", "items": { "$ref": "#/components/schemas/SummaryText" }, "title": "Summary", "type": "array" }, "type": { "const": "reasoning", "default": "reasoning", "description": "output item kind", "title": "Type", "type": "string" } }, "required": [ "id", "summary" ], "title": "ReasoningOutput", "type": "object" }, "ReasoningParam": { "additionalProperties": false, "description": "What the caller asks of the model's own thinking on this turn.\n\nThe Responses API's own shape. An `effort` left unset is not sent, so each model keeps its own\ndepth; a `summary` left unset is the calling key's or its organisation's default, `auto`\nunless one of them turned it off, and is asked of a model declared with `thinking` alone;\n`none` is the caller's no to that default (`app.providers.capabilities.reasoning_ask`). A\nvalue the caller sets and a provider refuses fails the turn upstream, exactly as\n`temperature` on `claude-opus-5` does. The one summary dropped to make a call succeed is the\none OpenAI refuses an organisation it has not verified\n(`docs/architecture/responses.md` \"Reasoning\").", "properties": { "effort": { "anyOf": [ { "enum": [ "none", "minimal", "low", "medium", "high", "xhigh", "max" ], "type": "string" }, { "type": "null" } ], "description": "how hard the model should think before answering. Anthropic reads it as `output_config.effort` and an OpenAI-family model as `reasoning_effort`; a model that does not accept the value fails the turn rather than ignoring it", "title": "Effort" }, "generate_summary": { "anyOf": [ { "enum": [ "auto", "concise", "detailed" ], "type": "string" }, { "const": "none", "type": "string" }, { "type": "null" } ], "description": "the vendor's older name for `summary`, read as it when `summary` is not set; `summary` wins when both are", "title": "Generate Summary" }, "summary": { "anyOf": [ { "enum": [ "auto", "concise", "detailed" ], "type": "string" }, { "const": "none", "type": "string" }, { "type": "null" } ], "description": "ask for the model's reasoning back in readable form, and how long. Left out, a model that thinks is asked for `auto` unless the calling key or its organisation turned summaries off. `none` asks for no summary on this turn, whatever those settings say, and is accepted on every model: the model still reasons at its `effort`, and the reasoning tokens are still metered. Anthropic has one readable form, so all three lengths mean the same thing there; an OpenAI-family provider Core reaches through chat completions rather than the Responses API is asked for none at all, and its reasoning item then carries an empty summary. Where OpenAI has not verified the deployment's organisation it writes no summaries: the turn still answers, without one", "title": "Summary" } }, "title": "ReasoningParam", "type": "object" }, "RecordAggregate": { "additionalProperties": false, "description": "Aggregation function over records.", "properties": { "field": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field to aggregate (required except for count)", "title": "Field" }, "fn": { "description": "Aggregate function", "enum": [ "count", "sum", "avg", "min", "max" ], "title": "Fn", "type": "string" } }, "required": [ "fn" ], "title": "RecordAggregate", "type": "object" }, "RecordFilter": { "additionalProperties": false, "description": "Filter expression over record fields.", "properties": { "field": { "description": "Field name", "title": "Field", "type": "string" }, "op": { "description": "Comparison operator", "enum": [ "eq", "ne", "lt", "lte", "gt", "gte", "contains" ], "title": "Op", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ], "description": "Filter value", "title": "Value" } }, "required": [ "field", "op", "value" ], "title": "RecordFilter", "type": "object" }, "RecordQuery": { "additionalProperties": false, "description": "Query over structured records.", "properties": { "aggregate": { "anyOf": [ { "$ref": "#/components/schemas/RecordAggregate" }, { "type": "null" } ], "description": "Aggregation" }, "filters": { "description": "Filter expressions", "items": { "$ref": "#/components/schemas/RecordFilter" }, "title": "Filters", "type": "array" }, "group_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Group by field", "title": "Group By" }, "limit": { "default": 50, "description": "Result limit; bounded here, not only at each caller, since a query can also be built by a model (`tabular_query`) rather than sent by a caller", "maximum": 500.0, "minimum": 1.0, "title": "Limit", "type": "integer" } }, "title": "RecordQuery", "type": "object" }, "RecordSort": { "additionalProperties": false, "description": "The one field a record query is ordered by.", "properties": { "direction": { "default": "asc", "description": "`asc` for smallest first, `desc` for largest first", "enum": [ "asc", "desc" ], "title": "Direction", "type": "string" }, "field": { "description": "the field to order by", "maxLength": 256, "minLength": 1, "title": "Field", "type": "string" } }, "required": [ "field" ], "title": "RecordSort", "type": "object" }, "RecordsSourceCreate": { "additionalProperties": false, "description": "Body of `POST /knowledge/collections/{id}/sources` for `kind: \"records\"`.", "properties": { "kind": { "const": "records", "description": "Source kind", "title": "Kind", "type": "string" }, "records": { "description": "Flat JSON records (1 to 50k rows); an empty list is refused, since an index could extract nothing from it", "items": { "additionalProperties": true, "type": "object" }, "maxItems": 50000, "minItems": 1, "title": "Records", "type": "array" }, "title": { "description": "Human-readable source title", "maxLength": 255, "minLength": 1, "title": "Title", "type": "string" } }, "required": [ "kind", "title", "records" ], "title": "RecordsSourceCreate", "type": "object" }, "RecoveryNote": { "description": "Which attempt a recovery call's answer is checked as, and the check it recovers.", "properties": { "attempt": { "description": "the attempt this call's answer is checked as, from 2", "title": "Attempt", "type": "integer" }, "check": { "description": "the name of the first check the earlier answer failed", "title": "Check", "type": "string" } }, "required": [ "attempt", "check" ], "title": "RecoveryNote", "type": "object" }, "RefusalContent": { "additionalProperties": false, "description": "The model's refusal to answer.", "properties": { "refusal": { "description": "the model's refusal text", "title": "Refusal", "type": "string" }, "type": { "const": "refusal", "default": "refusal", "description": "output content kind", "title": "Type", "type": "string" } }, "required": [ "refusal" ], "title": "RefusalContent", "type": "object" }, "RefusalPart": { "additionalProperties": false, "description": "An assistant message's own prior refusal, replayed on the request.", "properties": { "refusal": { "description": "the replayed refusal text", "title": "Refusal", "type": "string" }, "type": { "const": "refusal", "default": "refusal", "description": "content part kind", "title": "Type", "type": "string" } }, "required": [ "refusal" ], "title": "RefusalPart", "type": "object" }, "RefusalStopDetails": { "additionalProperties": false, "description": "Why a turn stopped at a refusal.", "properties": { "category": { "description": "always null: the categories are the vendor's classifier's, and the model Core called did not name one", "title": "Category", "type": "null" }, "explanation": { "description": "the refusal, in the model's own words", "title": "Explanation", "type": "string" }, "type": { "const": "refusal", "default": "refusal", "description": "the stop detail's kind", "title": "Type", "type": "string" } }, "required": [ "explanation" ], "title": "RefusalStopDetails", "type": "object" }, "ReindexRequest": { "additionalProperties": false, "description": "Body of `POST /knowledge/indexes/{id}/reindex`; the whole body may be left off, and is by\nevery caller written before modes existed.\n\n`full` re-ingests every source the index currently draws in and sweeps what it no longer\ndoes; `failed` re-queues only the pairs whose last ingestion failed and sweeps nothing.\nIncremental needs no mode: creating a source already ingests it into the indexes that draw it\nin, patching its metadata re-routes it, and deleting it takes its chunks with it.", "properties": { "mode": { "default": "full", "description": "'full' re-ingests every source in scope; 'failed' retries only the pairs whose last ingestion failed", "enum": [ "full", "failed" ], "title": "Mode", "type": "string" } }, "title": "ReindexRequest", "type": "object" }, "RelationCreate": { "additionalProperties": false, "description": "Body of `POST /knowledge/graphs/{graph_id}/relations`.", "properties": { "from_entity_id": { "description": "the entity the relation starts from", "title": "From Entity Id", "type": "string" }, "properties": { "additionalProperties": true, "description": "the relation's properties, checked against its type's schema", "title": "Properties", "type": "object" }, "to_entity_id": { "description": "the entity the relation points to", "title": "To Entity Id", "type": "string" }, "type": { "description": "a relation type of the schema", "maxLength": 64, "minLength": 1, "title": "Type", "type": "string" } }, "required": [ "type", "from_entity_id", "to_entity_id" ], "title": "RelationCreate", "type": "object" }, "RelationRead": { "description": "One relation, as the reader may see it.", "properties": { "created_at": { "description": "When it was first written", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who first wrote it: a key's id, or `operator:`", "title": "Created By", "type": "string" }, "from_entity_id": { "description": "The entity it starts from", "title": "From Entity Id", "type": "string" }, "graph_id": { "description": "Owning graph id", "title": "Graph Id", "type": "string" }, "id": { "description": "Relation id", "title": "Id", "type": "string" }, "object": { "const": "knowledge_graph.relation", "default": "knowledge_graph.relation", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "description": "`manual` or `extracted`", "enum": [ "manual", "extracted" ], "title": "Origin", "type": "string" }, "properties": { "additionalProperties": true, "description": "Its properties", "title": "Properties", "type": "object" }, "schema_version": { "description": "The schema version it was validated against", "title": "Schema Version", "type": "integer" }, "sources": { "description": "Up to five sources behind it that this reader may see; empty for a manual relation", "items": { "$ref": "#/components/schemas/FactSource" }, "title": "Sources", "type": "array" }, "to_entity_id": { "description": "The entity it points to", "title": "To Entity Id", "type": "string" }, "type": { "description": "The relation's type", "title": "Type", "type": "string" }, "updated_at": { "description": "When it was last written", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "graph_id", "type", "from_entity_id", "to_entity_id", "properties", "origin", "schema_version", "sources", "created_by", "created_at", "updated_at" ], "title": "RelationRead", "type": "object" }, "RelationType": { "additionalProperties": false, "description": "One relation type of a schema version.", "properties": { "description": { "default": "", "description": "what the relation means", "maxLength": 1024, "title": "Description", "type": "string" }, "from": { "description": "the entity types a relation of this type may start from", "items": { "type": "string" }, "maxItems": 50, "minItems": 1, "title": "From", "type": "array" }, "name": { "description": "the type's name, unique within the schema (`supplies`)", "pattern": "^[a-z][a-z0-9_]{0,63}$", "title": "Name", "type": "string" }, "properties": { "additionalProperties": true, "description": "a JSON Schema (Draft 2020-12) object describing the relation's properties", "title": "Properties", "type": "object" }, "to": { "description": "the entity types a relation of this type may point to", "items": { "type": "string" }, "maxItems": 50, "minItems": 1, "title": "To", "type": "array" } }, "required": [ "name", "from", "to" ], "title": "RelationType", "type": "object" }, "RelationUpdate": { "additionalProperties": false, "description": "Body of `PATCH /knowledge/graphs/{graph_id}/relations/{relation_id}`: only the properties\nchange; a relation between other entities, or of another type, is another relation.", "properties": { "properties": { "additionalProperties": true, "description": "the new properties, replacing the old, checked against the type", "title": "Properties", "type": "object" } }, "required": [ "properties" ], "title": "RelationUpdate", "type": "object" }, "Requires": { "additionalProperties": false, "description": "What a subscriber needs for this manifest to install at all.", "properties": { "capabilities": { "description": "capability names the subscriber's organisation must permit", "items": { "type": "string" }, "maxItems": 64, "title": "Capabilities", "type": "array" }, "models": { "description": "catalogue model ids the members name; recorded, not checked", "items": { "type": "string" }, "maxItems": 64, "title": "Models", "type": "array" } }, "title": "Requires", "type": "object" }, "RerankSettings": { "additionalProperties": false, "description": "A reranking pass over a memory search's fused results.", "properties": { "model": { "description": "chat model that reranks; the key's policy must allow it at search time", "minLength": 1, "title": "Model", "type": "string" }, "top_n": { "default": 20, "description": "how many fused results the model reranks", "maximum": 50.0, "minimum": 1.0, "title": "Top N", "type": "integer" } }, "required": [ "model" ], "title": "RerankSettings", "type": "object" }, "ResidencyExceptionView": { "description": "One residency exception a key's calls are decided with, and where it holds.", "properties": { "exception": { "description": "the exception as a document spells it: 'model:', 'host:', 'builtin:' or 'vendor:'", "title": "Exception", "type": "string" }, "where": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "the places the destination is reached in under this exception; null when it is reached wherever it is served, a place nobody declared included", "title": "Where" } }, "required": [ "exception", "where" ], "title": "ResidencyExceptionView", "type": "object" }, "ResidencyView": { "description": "Where a strict key's calls may go, as the documents it is decided under answer together\n(`docs/architecture/data-residency.md` \"What a key can read about where its calls go\").", "properties": { "region_exceptions": { "description": "every residency exception this key's calls are decided with, and where it holds: destinations reached although they are served outside `regions_allow`, as the key's document and its organisation's decide them, within what the organisations above admit; an exception an organisation above made is not listed. An exception one document makes holds where every other strict document's own regions admit the place. An exception that lets nothing through beyond `regions_allow` is left out", "items": { "$ref": "#/components/schemas/ResidencyExceptionView" }, "title": "Region Exceptions", "type": "array" }, "regions_allow": { "description": "the hosting regions every strict document admits -- the key's list, its organisation's and those of the organisations above met, places nesting as everywhere else; empty when they have nothing in common, which admits no destination at all", "items": { "type": "string" }, "title": "Regions Allow", "type": "array" } }, "required": [ "regions_allow", "region_exceptions" ], "title": "ResidencyView", "type": "object" }, "ResourceIn": { "additionalProperties": false, "description": "One resource file packaged alongside a skill: a relative path and its text content.", "properties": { "content": { "description": "the resource file's text content", "title": "Content", "type": "string" }, "path": { "description": "the resource's path within the skill package", "pattern": "^[A-Za-z0-9._/-]{1,200}$", "title": "Path", "type": "string" } }, "required": [ "path", "content" ], "title": "ResourceIn", "type": "object" }, "ResourceLabelRead": { "description": "One classification, as `GET`/`PUT /labels/{kind}/{name}` and the listing answer it.", "properties": { "created_at": { "description": "When this classification was first written", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who first classified this name: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "kind": { "description": "What `name` names: 'tool' for a qualified tool name, 'model' for a catalogue model id", "enum": [ "tool", "model" ], "title": "Kind", "type": "string" }, "labels": { "description": "The organisation's classification of that tool or model, as label -> value", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "name": { "description": "The qualified tool name or catalogue model id", "title": "Name", "type": "string" }, "object": { "const": "resource_label", "default": "resource_label", "description": "The object's type", "title": "Object", "type": "string" }, "updated_at": { "description": "When this classification was last replaced", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "kind", "name", "labels", "created_by", "created_at", "updated_at" ], "title": "ResourceLabelRead", "type": "object" }, "ResourceLabelWrite": { "additionalProperties": false, "description": "Body of `PUT /labels/{kind}/{name}`: the whole classification, replacing whatever is\nstored. A `PUT` rather than a `PATCH` because a classification is one statement -- \"this tool\nis payroll's, for everyone\" -- and merging two of them is how an organisation ends up with a\nlabel nobody meant to leave behind.", "properties": { "labels": { "description": "The organisation's classification of this tool or model, as label -> value; at most 32 names, values of 1 to 256 characters. Never a person's id or an attribute value: a label says what the thing is, an attribute says who the request is for", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" } }, "required": [ "labels" ], "title": "ResourceLabelWrite", "type": "object" }, "ResponseCheckRead": { "description": "One live check's result on one turn, as the API returns it.", "properties": { "attempt": { "description": "Which answer of the turn was checked, from 1", "title": "Attempt", "type": "integer" }, "created_at": { "description": "When the check was decided", "format": "date-time", "title": "Created At", "type": "string" }, "id": { "description": "Result id", "title": "Id", "type": "string" }, "judge_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The model that judged a judged kind, or null", "title": "Judge Model" }, "kind": { "description": "The check's kind", "title": "Kind", "type": "string" }, "mode": { "description": "`block` or `background`", "title": "Mode", "type": "string" }, "name": { "description": "The check's name, as its list names it", "title": "Name", "type": "string" }, "object": { "const": "response.check", "default": "response.check", "description": "The object's type", "title": "Object", "type": "string" }, "outcome": { "description": "`passed`, `failed` or `errored`", "title": "Outcome", "type": "string" }, "passed_on_error": { "description": "Whether this `errored` result let the turn go on, by its check's `on_error: pass`; false for every other result", "title": "Passed On Error", "type": "boolean" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why: a fixed sentence for a rule or a check that could not decide, the judge's own sentence for a judged kind (empty for a sealed agent's), or null", "title": "Reason" }, "response_id": { "description": "The turn the check was applied to", "title": "Response Id", "type": "string" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The score, 0 to 1, or null", "title": "Score" }, "source": { "description": "Whose list the check is on: `organisation` (its policy document) or `agent` (the agent version); each list's names are its own", "title": "Source", "type": "string" }, "stage": { "description": "`input` (the caller's text) or `output` (the answer)", "title": "Stage", "type": "string" } }, "required": [ "id", "response_id", "name", "source", "stage", "kind", "mode", "attempt", "outcome", "score", "reason", "judge_model", "passed_on_error", "created_at" ], "title": "ResponseCheckRead", "type": "object" }, "ResponseError": { "additionalProperties": false, "description": "A response's terminal failure.", "properties": { "code": { "description": "a stable machine-readable error code. Core's own -- `turn_deadline_exceeded`, `usage_cap_exceeded`, `server_shutdown`, `model_error`, `model_request_rejected`, `model_rate_limited`, `unsupported_parameter`, `approval_expired` -- rather than one of OpenAI's, because the code is what a caller acts on (`docs/architecture/api-conventions.md`, 'Where this departs from Responses compatibility')", "title": "Code", "type": "string" }, "message": { "description": "a safe, fixed-wording description of the failure", "title": "Message", "type": "string" } }, "required": [ "code", "message" ], "title": "ResponseError", "type": "object" }, "ResponseObject": { "additionalProperties": false, "description": "A Responses-compatible turn: its output items and lifecycle state.", "properties": { "background": { "description": "whether this response ran asynchronously", "title": "Background", "type": "boolean" }, "completed_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "unix timestamp the response reached a terminal status; null while it has not", "title": "Completed At" }, "conversation": { "anyOf": [ { "$ref": "#/components/schemas/Conversation" }, { "type": "null" } ], "description": "the thread this response's items were stored on; null for a stateless turn" }, "cost_limit_eur": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "the cost limit in euro this background run and what it started run under; null when the request sent none. A Core extension", "title": "Cost Limit Eur" }, "created_at": { "description": "unix timestamp the response was created", "title": "Created At", "type": "integer" }, "error": { "anyOf": [ { "$ref": "#/components/schemas/ResponseError" }, { "type": "null" } ], "description": "the failure, when status is failed" }, "id": { "description": "the response's id", "title": "Id", "type": "string" }, "incomplete_details": { "anyOf": [ { "$ref": "#/components/schemas/IncompleteDetails" }, { "type": "null" } ], "description": "why the response is incomplete, when status is incomplete" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the standing developer instruction this turn ran under; `[sealed]` in its place when a sealed agent copy supplied it, whose words the publication withholds from this organisation while the model is still given them", "title": "Instructions" }, "labels": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "default": {}, "description": "the labels the rules over this row's kind read, as label -> a value or a list of values, read back exactly as written", "title": "Labels", "type": "object" }, "max_output_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "the ceiling on generated output tokens this turn ran under", "title": "Max Output Tokens" }, "metadata": { "additionalProperties": { "type": "string" }, "default": {}, "description": "caller-supplied key/value pairs", "title": "Metadata", "type": "object" }, "model": { "description": "the model that answered this turn. The model actually used, which is the one the key's routing configuration fell over to when the requested one could not answer -- upstream's `model` is the resolved snapshot rather than the alias a caller typed, and so is this (`docs/architecture/responses.md#fallback-routing`)", "title": "Model", "type": "string" }, "object": { "const": "response", "default": "response", "description": "the object's wire type", "title": "Object", "type": "string" }, "output": { "default": [], "description": "items this turn produced or replayed", "items": { "discriminator": { "mapping": { "custom_tool_call": "#/components/schemas/CustomToolCallOutput", "function_call": "#/components/schemas/FunctionCallOutput", "mcp_approval_request": "#/components/schemas/McpApprovalRequestOutput", "mcp_call": "#/components/schemas/McpCallOutput", "message": "#/components/schemas/MessageOutput", "reasoning": "#/components/schemas/ReasoningOutput" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/MessageOutput" }, { "$ref": "#/components/schemas/ReasoningOutput" }, { "$ref": "#/components/schemas/FunctionCallOutput" }, { "$ref": "#/components/schemas/CustomToolCallOutput" }, { "$ref": "#/components/schemas/McpCallOutput" }, { "$ref": "#/components/schemas/McpApprovalRequestOutput" } ] }, "title": "Output", "type": "array" }, "parallel_tool_calls": { "default": true, "description": "whether the model was allowed to ask for several tools in one round: what the request said, and `true` when it said nothing -- the field is required of a Responses object, and parallel is what a turn runs with unasked", "title": "Parallel Tool Calls", "type": "boolean" }, "previous_response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the response this one continues, when threads are effective", "title": "Previous Response Id" }, "prompt": { "anyOf": [ { "$ref": "#/components/schemas/ResponsePrompt" }, { "type": "null" } ], "description": "the stored prompt this turn rendered, when it named one" }, "reasoning": { "anyOf": [ { "$ref": "#/components/schemas/ReasoningParam" }, { "type": "null" } ], "description": "what this turn asked of the model's own thinking" }, "status": { "description": "the response's lifecycle state", "enum": [ "queued", "in_progress", "requires_action", "completed", "failed", "cancelled", "incomplete" ], "title": "Status", "type": "string" }, "temperature": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "the sampling temperature this turn ran under", "title": "Temperature" }, "text": { "anyOf": [ { "$ref": "#/components/schemas/TextFormat" }, { "type": "null" } ], "description": "the output text format this turn was held to" }, "tool_approval": { "anyOf": [ { "$ref": "#/components/schemas/ToolApprovalOption" }, { "type": "null" } ], "description": "the approval modes this background run parks tool calls under -- the request's own, or its agent's when the request sent none -- with the wait that runs, the shorter of the two; null when neither sent one. A Core extension" }, "tool_choice": { "anyOf": [ { "enum": [ "auto", "none", "required" ], "type": "string" }, { "$ref": "#/components/schemas/ToolChoiceFunction" } ], "default": "auto", "description": "how the model was allowed to use the offered tools: one of the three words, or the one tool the request named", "title": "Tool Choice" }, "tools": { "default": [], "description": "the tools this turn offered, as they were accepted", "items": { "discriminator": { "mapping": { "custom": "#/components/schemas/CustomToolEcho", "function": "#/components/schemas/FunctionToolEcho", "mcp": "#/components/schemas/McpToolEcho", "namespace": "#/components/schemas/NamespaceToolEcho" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/FunctionToolEcho" }, { "$ref": "#/components/schemas/CustomToolEcho" }, { "$ref": "#/components/schemas/NamespaceToolEcho" }, { "$ref": "#/components/schemas/McpToolEcho" } ] }, "title": "Tools", "type": "array" }, "top_p": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "the nucleus sampling mass this turn asked for; null when the request set none, which sends the provider nothing and leaves the model its own default", "title": "Top P" }, "truncation": { "const": "disabled", "default": "disabled", "description": "always `disabled`: Core never drops context to make a call fit, so `auto` is refused on the request", "title": "Truncation", "type": "string" }, "usage": { "anyOf": [ { "$ref": "#/components/schemas/Usage" }, { "type": "null" } ], "description": "token usage for this turn, once known" } }, "required": [ "id", "created_at", "status", "model", "background" ], "title": "ResponseObject", "type": "object" }, "ResponsePrompt": { "additionalProperties": false, "description": "The stored prompt this turn rendered, as the version it actually resolved to.", "properties": { "id": { "description": "the prompt's id", "title": "Id", "type": "string" }, "variables": { "additionalProperties": { "type": "string" }, "default": {}, "description": "always empty: the values a caller substituted are the caller's own content and are answered on the rendered item, never repeated here", "title": "Variables", "type": "object" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the version that rendered, as a string, upstream's own type", "title": "Version" } }, "required": [ "id" ], "title": "ResponsePrompt", "type": "object" }, "RetainedFor": { "const": "bookkeeping", "type": "string" }, "RetrievalQueryRequest": { "additionalProperties": false, "description": "Body of `POST /knowledge/retrieval-tools/{id}/query`.\n\n`metadata` only ever narrows: it is ANDed with the tool's own `metadata_filter`\n(`app.knowledge.pipelines.components.retrieval.filters`), so naming another value for a key\nthe tool already filters on is a contradiction rather than a re-scoping -- no hits, never the\nwider of the two. A caller cannot reach outside what the tool was configured to see.", "properties": { "graph_query": { "anyOf": [ { "$ref": "#/components/schemas/GraphQueryArgs" }, { "type": "null" } ], "description": "A typed query over one knowledge graph the tool offers, for a tool whose pipeline has a graph_query step in 'arguments' mode -- what a model passes as the tool's own graph_query argument; ignored by a pipeline without one" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Metadata filter, matched by JSONB containment, ANDed with the tool's own; naming another value for a key the tool already filters on matches nothing", "title": "Metadata", "type": "object" }, "query": { "description": "The question to retrieve for", "maxLength": 4000, "minLength": 1, "title": "Query", "type": "string" }, "table_query": { "anyOf": [ { "$ref": "#/components/schemas/TableQueryArgs" }, { "type": "null" } ], "description": "A structured query over one table the tool offers, for a tool whose pipeline has a tabular_query step in 'arguments' mode -- what a model passes as the tool's own table_query argument; ignored by a pipeline without one" }, "top_k": { "anyOf": [ { "maximum": 50.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "Cap on the hits returned; the pipeline's own if null", "title": "Top K" } }, "required": [ "query" ], "title": "RetrievalQueryRequest", "type": "object" }, "RetrievalRunRead": { "description": "What one retrieval run produced: its hits, the tables a `tabular_query` node read, the\nfacts graph steps found, the answer a synthesizing node wrote (if any), and one trace entry\nper node that ran.", "properties": { "answer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The answer a `response_synthesizer` wrote, when the pipeline had one", "title": "Answer" }, "graphs": { "description": "What each graph step found in each graph: the entities and relations it reached as the request's person sees them, with the sources behind each, and for a graph_query its paths and the typed query Core validated", "items": { "$ref": "#/components/schemas/GraphHit" }, "title": "Graphs", "type": "array" }, "object": { "const": "retrieval_run", "default": "retrieval_run", "description": "The object's type", "title": "Object", "type": "string" }, "results": { "description": "The ranked hits", "items": { "$ref": "#/components/schemas/Hit" }, "title": "Results", "type": "array" }, "tables": { "description": "What each `tabular_query` node read: the table, the typed query Core validated, and the rows it returned", "items": { "$ref": "#/components/schemas/TableHit" }, "title": "Tables", "type": "array" }, "trace": { "description": "One entry per node that ran, in run order", "items": { "$ref": "#/components/schemas/TraceEntry" }, "title": "Trace", "type": "array" } }, "required": [ "trace" ], "title": "RetrievalRunRead", "type": "object" }, "RetrievalToolCreate": { "additionalProperties": false, "description": "Body of `POST /knowledge/retrieval-tools`.", "properties": { "description": { "default": "", "description": "Model-visible description of what this tool searches", "maxLength": 1024, "title": "Description", "type": "string" }, "filter_keys": { "description": "Metadata keys a model may filter this tool's search on; each becomes an optional argument whose value is ANDed under the tool's own metadata_filter. It narrows index and collection reads only, never a knowledge graph", "items": { "type": "string" }, "maxItems": 8, "title": "Filter Keys", "type": "array" }, "labels": { "default": {}, "description": "The organisation's classification of this tool, as label -> value; what the rules over `tool` read", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the tool, at most 16 KiB serialised: stored, returned and never read by Core; omitted or null stores {}", "title": "Metadata" }, "metadata_filter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Only content whose metadata contains this is reachable through this tool, from every index and collection block of its pipeline; null narrows nothing. Refused (422) for a pipeline version with a graph block: a knowledge graph cannot be filtered by metadata", "title": "Metadata Filter" }, "name": { "description": "Tool name, unique per tenant; the model sees `knowledge__`. `uploads` is refused (422): it names the search over an API key's own files", "pattern": "^[a-z0-9_-]{1,48}$", "title": "Name", "type": "string" }, "pipeline": { "$ref": "#/components/schemas/PipelineRef", "description": "The retrieval pipeline version this tool runs, as {pipeline_id, version}: everything the tool reaches is a source block of that version. A {template} is refused" } }, "required": [ "name", "pipeline" ], "title": "RetrievalToolCreate", "type": "object" }, "RetrievalToolRead": { "description": "A knowledge tool, as the API returns it.", "properties": { "created_at": { "description": "When this tool was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created the tool: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "description": { "description": "Model-visible description of what this tool searches", "title": "Description", "type": "string" }, "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "filter_keys": { "description": "Metadata keys a model may filter this tool's search on", "items": { "type": "string" }, "title": "Filter Keys", "type": "array" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "id": { "description": "Retrieval tool id", "title": "Id", "type": "string" }, "labels": { "default": {}, "description": "The organisation's classification of this tool, as label -> value", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "latest_version": { "default": 1, "description": "The highest published version, which the description, filter keys, pin and filter are; 0 for a tool with only drafts, which only the management twin reads as its newest draft", "title": "Latest Version", "type": "integer" }, "metadata": { "additionalProperties": true, "default": {}, "description": "The opaque document attached to this tool; {} when none was set", "title": "Metadata", "type": "object" }, "metadata_filter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Only content whose metadata contains this is reachable through this tool; null narrows nothing", "title": "Metadata Filter" }, "name": { "description": "Tool name, unique per tenant; the model sees `knowledge__`", "title": "Name", "type": "string" }, "object": { "const": "retrieval_tool", "default": "retrieval_tool", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/OriginRead" }, { "type": "null" } ], "description": "The subscription that installed this tool, and the publication it came from; null for a tool this organisation registered itself. A sealed publication withholds `metadata_filter`, and a turn still narrows by it" }, "pipeline": { "anyOf": [ { "$ref": "#/components/schemas/PipelineRef" }, { "type": "null" } ], "description": "The retrieval pipeline version this tool runs; null once that pipeline was deleted, and the tool then answers that its pipeline no longer exists" }, "updated_at": { "description": "When this tool was last updated", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "name", "description", "filter_keys", "pipeline", "metadata_filter", "created_by", "created_at", "updated_at" ], "title": "RetrievalToolRead", "type": "object" }, "RetrievalToolUpdate": { "additionalProperties": false, "description": "Body of `PATCH /knowledge/retrieval-tools/{id}`. A field left out of the request is left\nalone; `metadata_filter` is a genuinely nullable target (an explicit `null` resets it to\n\"narrow nothing\"), so `model_fields_set` -- not the field's own value -- decides whether one\nwas sent. `pipeline` repoints the tool at another version, checked against the key doing it\nexactly as creating the tool was; it cannot be cleared, since a tool is its pipeline.\n\n`name` has no field here: it is what a rule over `tool`, a usage row and an audit subject all\ncarry as `knowledge__`, so a rename would move the tool out from under every glob that\nnamed it and split its history in two. Register another and delete this one, deliberately.", "properties": { "description": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "Model-visible description", "title": "Description" }, "filter_keys": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 8, "type": "array" }, { "type": "null" } ], "description": "Metadata keys a model may filter this tool's search on; an empty list offers none", "title": "Filter Keys" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "new classification of this tool, replacing whatever is stored; omitted leaves it alone, and an empty map clears it", "title": "Labels" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "new opaque document, replacing whatever is stored whole; omitted leaves it alone, and {} clears it", "title": "Metadata" }, "metadata_filter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Only content whose metadata contains this is reachable through this tool; null narrows nothing. Refused (422) while the pinned version has a graph block: a knowledge graph cannot be filtered by metadata", "title": "Metadata Filter" }, "pipeline": { "anyOf": [ { "$ref": "#/components/schemas/PipelineRef" }, { "type": "null" } ], "description": "Another version to pin, as {pipeline_id, version}; omitted leaves it alone" } }, "title": "RetrievalToolUpdate", "type": "object" }, "RetrievalToolVersionRead": { "description": "One immutable version of a retrieval tool, as `GET .../versions[/{version}]` returns it.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "created_at": { "description": "When this version was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created this version", "title": "Created By", "type": "string" }, "description": { "description": "Model-visible description of what this tool searches", "title": "Description", "type": "string" }, "filter_keys": { "description": "Metadata keys a model may filter this tool's search on", "items": { "type": "string" }, "title": "Filter Keys", "type": "array" }, "metadata_filter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Only content whose metadata contains this is reachable; null narrows nothing, and null for a sealed copy, whose publication withholds it", "title": "Metadata Filter" }, "object": { "const": "retrieval_tool_version", "default": "retrieval_tool_version", "description": "The object's type", "title": "Object", "type": "string" }, "pipeline": { "anyOf": [ { "$ref": "#/components/schemas/PipelineRef" }, { "type": "null" } ], "description": "The retrieval pipeline version this version runs; null once that pipeline was deleted" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "state": { "default": "published", "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "tool_id": { "description": "Retrieval tool this version belongs to", "title": "Tool Id", "type": "string" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" } }, "required": [ "tool_id", "version", "description", "filter_keys", "pipeline", "metadata_filter", "created_by", "acted_for", "created_at" ], "title": "RetrievalToolVersionRead", "type": "object" }, "RouterListing": { "description": "What `GET /models` says about a router beyond what every entry says.", "properties": { "pool": { "description": "the models a turn on it may land on, in the router's order, already narrowed to what the calling key may use", "items": { "type": "string" }, "title": "Pool", "type": "array" }, "version": { "description": "the router version a turn on it is routed by right now", "title": "Version", "type": "integer" } }, "required": [ "version", "pool" ], "title": "RouterListing", "type": "object" }, "Routing": { "description": "Which models were tried for this call, and which answered.", "properties": { "answered": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the model that answered; null when none did", "title": "Answered" }, "attempted": { "description": "the model this call was made to", "title": "Attempted", "type": "string" }, "chain": { "description": "the ordered model ids this turn may fall over along, the requested one first; empty when the key configured no fallback", "items": { "type": "string" }, "title": "Chain", "type": "array" } }, "required": [ "attempted" ], "title": "Routing", "type": "object" }, "RoutingConfigCreate": { "additionalProperties": false, "description": "Body of `POST /tenants/{tenant_id}/routing-configs`.", "properties": { "chains": { "description": "One chain per primary model; at least one", "items": { "$ref": "#/components/schemas/Chain" }, "title": "Chains", "type": "array" }, "name": { "description": "Human-readable name", "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name", "chains" ], "title": "RoutingConfigCreate", "type": "object" }, "RoutingConfigRead": { "description": "A routing configuration, as the management API returns it.", "properties": { "chains": { "description": "One entry per primary model: its id and the ordered ids to try instead, as the latest published version holds them; empty while every version is a draft", "items": { "$ref": "#/components/schemas/Chain" }, "title": "Chains", "type": "array" }, "created_at": { "description": "When this configuration was created", "format": "date-time", "title": "Created At", "type": "string" }, "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "id": { "description": "Routing configuration id", "title": "Id", "type": "string" }, "latest_version": { "description": "The published version `chains` is; 0 while every version is a draft, which only the management twin reads", "title": "Latest Version", "type": "integer" }, "name": { "description": "Human-readable name, unique within the tenant", "title": "Name", "type": "string" }, "object": { "const": "routing_config", "default": "routing_config", "description": "The object's type", "title": "Object", "type": "string" }, "tenant_id": { "description": "Owning tenant id", "title": "Tenant Id", "type": "string" }, "updated_at": { "description": "When this configuration was last updated", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "name", "chains", "latest_version", "created_at", "updated_at" ], "title": "RoutingConfigRead", "type": "object" }, "RoutingConfigUpdate": { "additionalProperties": false, "description": "Body of `PATCH /tenants/{tenant_id}/routing-configs/{config_id}`; every field is optional\nand left alone when absent.", "properties": { "chains": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Chain" }, "type": "array" }, { "type": "null" } ], "description": "Replaces every chain; at least one", "title": "Chains" }, "name": { "anyOf": [ { "maxLength": 200, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Human-readable name", "title": "Name" } }, "title": "RoutingConfigUpdate", "type": "object" }, "RoutingConfigVersionRead": { "description": "One version of a routing configuration, as the API returns it.", "properties": { "chains": { "description": "One entry per primary model: its id and the ordered ids to try instead", "items": { "$ref": "#/components/schemas/Chain" }, "title": "Chains", "type": "array" }, "created_at": { "description": "When the version was written", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who wrote the version: a key's id, `operator:` for a person, or null for the version recorded from a configuration that predates versions", "title": "Created By" }, "object": { "const": "routing_config.version", "default": "routing_config.version", "description": "The object's type", "title": "Object", "type": "string" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "routing_config_id": { "description": "The configuration this version belongs to", "title": "Routing Config Id", "type": "string" }, "state": { "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" } }, "required": [ "routing_config_id", "version", "state", "published_at", "chains", "created_by", "created_at" ], "title": "RoutingConfigVersionRead", "type": "object" }, "RoutingConfigView": { "description": "The routing configuration in force for the calling key, as `GET /key` names it: which one\nit is, never what it says. A key may ask which models it falls over to through `GET /models`,\nwhere each model carries its own effective chain; naming the whole table here would repeat\nthat answer in a shape nothing resolves against.", "properties": { "id": { "description": "Routing configuration id", "title": "Id", "type": "string" }, "name": { "description": "Its human-readable name", "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "RoutingConfigView", "type": "object" }, "RoutingDecisionRead": { "description": "How one routed turn was routed: labels, numbers and model ids, never text.", "properties": { "candidates": { "description": "Every pool member in order, kept or with the reason it was dropped", "items": { "$ref": "#/components/schemas/CandidateRead" }, "title": "Candidates", "type": "array" }, "classifier": { "anyOf": [ { "$ref": "#/components/schemas/ClassifierRead" }, { "type": "null" } ], "description": "What classified the turn; null when nothing did" }, "created_at": { "description": "When the turn was routed", "format": "date-time", "title": "Created At", "type": "string" }, "difficulty": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The effective difficulty, after the threshold and momentum; null when the task type was not trusted", "title": "Difficulty" }, "elapsed_ms": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "What the classification cost the turn, the hop included; null when there was no hop", "title": "Elapsed Ms" }, "list": { "description": "Which list the model came from: `.`, `default`, or `pool` when both fell through", "title": "List", "type": "string" }, "low_probability": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The calibrated probability of `low`", "title": "Low Probability" }, "model": { "description": "The chosen model", "title": "Model", "type": "string" }, "momentum": { "description": "Whether momentum raised the difficulty", "title": "Momentum", "type": "boolean" }, "nearest_similarity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Similarity to the nearest labelled example", "title": "Nearest Similarity" }, "object": { "const": "routing_decision", "default": "routing_decision", "description": "The object's type", "title": "Object", "type": "string" }, "reason": { "description": "Why the list was used: `classified`, `classifier_unavailable`, `classifier_unconfigured`, `no_text`, `out_of_distribution` or `low_confidence`", "title": "Reason", "type": "string" }, "response_id": { "description": "The turn this decision routed", "title": "Response Id", "type": "string" }, "router_id": { "description": "The router the caller named as `model`", "title": "Router Id", "type": "string" }, "router_version": { "description": "The router version that decided", "title": "Router Version", "type": "integer" }, "task_confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Its calibrated probability", "title": "Task Confidence" }, "task_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The most probable task type", "title": "Task Type" } }, "required": [ "response_id", "router_id", "router_version", "classifier", "task_type", "task_confidence", "difficulty", "low_probability", "nearest_similarity", "momentum", "reason", "list", "candidates", "model", "elapsed_ms", "created_at" ], "title": "RoutingDecisionRead", "type": "object" }, "Rule": { "additionalProperties": false, "description": "One statement of a document: `effect` on every `kind` thing `match` covers, `when` every\natom holds.", "properties": { "actions": { "anyOf": [ { "items": { "enum": [ "see", "use", "write", "delete" ], "type": "string" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "description": "the actions this rule is about: `see` (listed or read by id), `use` (used by a turn, a run or a call), `write` (created, changed, renamed, relabelled or versioned) and `delete`. Omitted or null is every action the kind admits. No action implies another. A library kind, `file` and `tool` admit all four, `model` `see` and `use`, the five row kinds `see`, `write` and `delete`; refused on `router`, `egress_host`, the three acts and `direct_turn`, and an action the kind does not admit is refused", "title": "Actions" }, "effect": { "description": "`permit` allows what the rule matches; `forbid` refuses it whatever any permit says", "enum": [ "permit", "forbid" ], "title": "Effect", "type": "string" }, "id": { "anyOf": [ { "pattern": "^[a-z](?:[a-z0-9-]{0,62}[a-z0-9])?$", "type": "string" }, { "type": "null" } ], "description": "this rule's own name, unique within its document: lowercase letters, digits and hyphens, starting with a letter, at most 64 characters. A decision names the rule that decided it by this id, or by its position in `rules` when it has none", "title": "Id" }, "kind": { "description": "the kind of thing this rule is about. `direct_turn` is a turn that names no agent; a rule over it only forbids, takes no names, labels or actions, and its `when` reads the person alone: such a turn is allowed unless a forbid matches", "enum": [ "model", "router", "tool", "prompt", "skill", "file", "agent", "schedule", "workflow", "knowledge_collection", "knowledge_index", "knowledge_graph", "datastore", "egress_host", "artifact_download", "share_link", "memory_write", "direct_turn", "thread", "memory_record", "knowledge_source", "stored_file", "datastore_record" ], "title": "Kind", "type": "string" }, "match": { "$ref": "#/components/schemas/Match", "description": "which things of the kind the rule is about; omitted is every one of them" }, "when": { "default": [], "description": "conditions on the person the request names; all must hold. An atom that reads the person never holds when nobody is named, so such a permit grants nothing and such a forbid refuses nothing for a request that names nobody. Refused on kinds never asked about a person: `router`, `egress_host` and the three acts. On `file`, `datastore` and `direct_turn`, whose things carry no labels, only `nobody_named` and `attribute_has`", "items": { "discriminator": { "mapping": { "attribute_has": "#/components/schemas/AttributeHas", "label_among": "#/components/schemas/LabelAmong", "label_is_subject": "#/components/schemas/LabelIsSubject", "nobody_named": "#/components/schemas/NobodyNamed" }, "propertyName": "atom" }, "oneOf": [ { "$ref": "#/components/schemas/NobodyNamed" }, { "$ref": "#/components/schemas/LabelIsSubject" }, { "$ref": "#/components/schemas/LabelAmong" }, { "$ref": "#/components/schemas/AttributeHas" } ] }, "maxItems": 16, "title": "When", "type": "array" } }, "required": [ "effect", "kind" ], "title": "Rule", "type": "object" }, "RunComparison": { "additionalProperties": false, "description": "Two concluded runs of one suite, side by side.", "properties": { "against": { "$ref": "#/components/schemas/ComparedRun", "description": "The second run, which the first is held against" }, "evaluation_id": { "description": "The suite both runs are of", "title": "Evaluation Id", "type": "string" }, "losses": { "description": "Steps where the first run scored lower than the second", "title": "Losses", "type": "integer" }, "run": { "$ref": "#/components/schemas/ComparedRun", "description": "The first run" }, "same_judge": { "description": "Whether both runs were judged by one fixed model. False when the models differ, and when either run had none fixed, since its steps were then judged by whatever model each turn ran on -- the scores are not comparable", "title": "Same Judge", "type": "boolean" }, "steps": { "description": "Every step, in the first run's order", "items": { "$ref": "#/components/schemas/ComparedStep" }, "title": "Steps", "type": "array" }, "tie_margin": { "description": "Two steps whose scores lie within this of each other are tied", "title": "Tie Margin", "type": "number" }, "ties": { "description": "Steps where the two scores lie within `tie_margin`", "title": "Ties", "type": "integer" }, "unscored": { "description": "Steps with no judged score on one side or both", "title": "Unscored", "type": "integer" }, "wins": { "description": "Steps where the first run scored higher than the second", "title": "Wins", "type": "integer" } }, "required": [ "evaluation_id", "run", "against", "same_judge", "tie_margin", "wins", "ties", "losses", "unscored", "steps" ], "title": "RunComparison", "type": "object" }, "RunCost": { "additionalProperties": false, "description": "What a concluded run's turns cost: their usage rows at the price in force for each.", "properties": { "cost_eur": { "description": "What those turns cost in euro, markups included; the judge's own calls are not counted. A floor when `unpriced_rows` is above zero", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Cost Eur", "type": "string" }, "input_tokens": { "description": "Input tokens of every turn the run made", "title": "Input Tokens", "type": "integer" }, "output_tokens": { "description": "Output tokens of every turn the run made", "title": "Output Tokens", "type": "integer" }, "unpriced_rows": { "description": "Usage rows no price covered: counted, and costing nothing in `cost_eur`", "title": "Unpriced Rows", "type": "integer" } }, "required": [ "input_tokens", "output_tokens", "cost_eur", "unpriced_rows" ], "title": "RunCost", "type": "object" }, "RunRead": { "description": "One run in full: the summary plus what it measured and everything it found.", "properties": { "agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The agent measured, or null once it was deleted", "title": "Agent Id" }, "agent_name": { "description": "The agent's name as it was when the run was queued", "title": "Agent Name", "type": "string" }, "agent_version": { "description": "The agent version this run replayed against", "title": "Agent Version", "type": "integer" }, "completed_steps": { "description": "Steps executed so far", "title": "Completed Steps", "type": "integer" }, "cost": { "anyOf": [ { "$ref": "#/components/schemas/RunCost" }, { "type": "null" } ], "description": "What the run's turns cost, counted when it concluded; null before" }, "created_at": { "description": "When the run was queued", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who queued the run: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "draft": { "default": false, "description": "Whether `agent_version` or `evaluation_version` is a draft: such a run, and every turn, thread and trace it left, is read on the management twin alone", "title": "Draft", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why the run itself could not finish, when it could not", "title": "Error" }, "evaluation_id": { "description": "The suite this run executes", "title": "Evaluation Id", "type": "string" }, "evaluation_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The suite version whose scenarios this run snapshotted; null for a run queued before suites had versions", "title": "Evaluation Version" }, "expired_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the organisation's retention window emptied this run's scenarios, results and thread ids; null while it still holds them. Its score, cost and status stay", "title": "Expired At" }, "finished_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When it reached a terminal status", "title": "Finished At" }, "fired_for": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The instant that was due when a schedule's fire queued this run, or null for a run a caller asked for", "title": "Fired For" }, "id": { "description": "Run id", "title": "Id", "type": "string" }, "judge_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The model every judged check goes to, fixed when the run was queued; null when each step is judged by the model its own turn ran on", "title": "Judge Model" }, "mean_latency_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Mean wall time of the turns made so far, in milliseconds", "title": "Mean Latency Ms" }, "mean_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Mean score of the judged checks decided so far, 0..1 -- beside `score`, because a run can keep every check above its threshold while its answers get worse; null while none was decided", "title": "Mean Score" }, "object": { "const": "evaluation.run", "default": "evaluation.run", "description": "The object's type", "title": "Object", "type": "string" }, "results": { "description": "One result per scenario executed so far", "items": { "$ref": "#/components/schemas/ScenarioResult" }, "title": "Results", "type": "array" }, "router": { "anyOf": [ { "$ref": "#/components/schemas/RunRouter" }, { "type": "null" } ], "description": "The router version this run's turns were routed by, fixed when it was queued; null when the agent version names a model" }, "run_as_key_id": { "description": "The key this run acts as: whose act every turn it made was, and who its tokens are billed to", "title": "Run As Key Id", "type": "string" }, "scenarios": { "description": "The suite's scenarios as they were when this run was queued", "items": { "$ref": "#/components/schemas/ScenarioRead" }, "title": "Scenarios", "type": "array" }, "schedule_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The schedule whose fire queued this run, or null for a run a caller asked for", "title": "Schedule Id" }, "score": { "description": "Passed steps over total steps, as a percentage", "title": "Score", "type": "integer" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When a worker began executing it", "title": "Started At" }, "status": { "description": "The run's lifecycle state", "enum": [ "queued", "running", "passed", "warnings", "failed", "errored", "cancelled" ], "title": "Status", "type": "string" }, "subject_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person every step's turn acted for, as `X-Core-Subject` named her when the run was queued; null for a run for nobody, which every run the management twin, a schedule or a trial queues is, and once that person is erased", "title": "Subject Id" }, "thread_ids": { "description": "One thread id per scenario executed; empty once the run has expired", "items": { "type": "string" }, "title": "Thread Ids", "type": "array" }, "total_steps": { "description": "Steps in the snapshot", "title": "Total Steps", "type": "integer" }, "trial_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The improvement trial this run measures, the agent's published version or its draft; null for any other run. A suite's run list and `latest_runs` leave such a run out", "title": "Trial Id" } }, "required": [ "id", "evaluation_id", "agent_id", "agent_name", "agent_version", "run_as_key_id", "schedule_id", "fired_for", "router", "judge_model", "status", "score", "mean_score", "mean_latency_ms", "cost", "completed_steps", "total_steps", "created_at", "started_at", "finished_at", "expired_at", "scenarios", "results", "error", "thread_ids", "created_by" ], "title": "RunRead", "type": "object" }, "RunRouter": { "additionalProperties": false, "description": "The router version a run's turns were routed by, fixed when it was queued.", "properties": { "id": { "description": "The router the agent version names as its model", "title": "Id", "type": "string" }, "version": { "description": "The router version every step's turn was routed by", "title": "Version", "type": "integer" } }, "required": [ "id", "version" ], "title": "RunRouter", "type": "object" }, "RunSummary": { "description": "One run as a list shows it: what was measured, how far it got, and what it concluded.", "properties": { "agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The agent measured, or null once it was deleted", "title": "Agent Id" }, "agent_name": { "description": "The agent's name as it was when the run was queued", "title": "Agent Name", "type": "string" }, "agent_version": { "description": "The agent version this run replayed against", "title": "Agent Version", "type": "integer" }, "completed_steps": { "description": "Steps executed so far", "title": "Completed Steps", "type": "integer" }, "cost": { "anyOf": [ { "$ref": "#/components/schemas/RunCost" }, { "type": "null" } ], "description": "What the run's turns cost, counted when it concluded; null before" }, "created_at": { "description": "When the run was queued", "format": "date-time", "title": "Created At", "type": "string" }, "draft": { "default": false, "description": "Whether `agent_version` or `evaluation_version` is a draft: such a run, and every turn, thread and trace it left, is read on the management twin alone", "title": "Draft", "type": "boolean" }, "evaluation_id": { "description": "The suite this run executes", "title": "Evaluation Id", "type": "string" }, "evaluation_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The suite version whose scenarios this run snapshotted; null for a run queued before suites had versions", "title": "Evaluation Version" }, "expired_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the organisation's retention window emptied this run's scenarios, results and thread ids; null while it still holds them. Its score, cost and status stay", "title": "Expired At" }, "finished_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When it reached a terminal status", "title": "Finished At" }, "fired_for": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The instant that was due when a schedule's fire queued this run, or null for a run a caller asked for", "title": "Fired For" }, "id": { "description": "Run id", "title": "Id", "type": "string" }, "judge_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The model every judged check goes to, fixed when the run was queued; null when each step is judged by the model its own turn ran on", "title": "Judge Model" }, "mean_latency_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Mean wall time of the turns made so far, in milliseconds", "title": "Mean Latency Ms" }, "mean_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Mean score of the judged checks decided so far, 0..1 -- beside `score`, because a run can keep every check above its threshold while its answers get worse; null while none was decided", "title": "Mean Score" }, "object": { "const": "evaluation.run", "default": "evaluation.run", "description": "The object's type", "title": "Object", "type": "string" }, "router": { "anyOf": [ { "$ref": "#/components/schemas/RunRouter" }, { "type": "null" } ], "description": "The router version this run's turns were routed by, fixed when it was queued; null when the agent version names a model" }, "run_as_key_id": { "description": "The key this run acts as: whose act every turn it made was, and who its tokens are billed to", "title": "Run As Key Id", "type": "string" }, "schedule_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The schedule whose fire queued this run, or null for a run a caller asked for", "title": "Schedule Id" }, "score": { "description": "Passed steps over total steps, as a percentage", "title": "Score", "type": "integer" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When a worker began executing it", "title": "Started At" }, "status": { "description": "The run's lifecycle state", "enum": [ "queued", "running", "passed", "warnings", "failed", "errored", "cancelled" ], "title": "Status", "type": "string" }, "subject_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person every step's turn acted for, as `X-Core-Subject` named her when the run was queued; null for a run for nobody, which every run the management twin, a schedule or a trial queues is, and once that person is erased", "title": "Subject Id" }, "total_steps": { "description": "Steps in the snapshot", "title": "Total Steps", "type": "integer" }, "trial_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The improvement trial this run measures, the agent's published version or its draft; null for any other run. A suite's run list and `latest_runs` leave such a run out", "title": "Trial Id" } }, "required": [ "id", "evaluation_id", "agent_id", "agent_name", "agent_version", "run_as_key_id", "schedule_id", "fired_for", "router", "judge_model", "status", "score", "mean_score", "mean_latency_ms", "cost", "completed_steps", "total_steps", "created_at", "started_at", "finished_at", "expired_at" ], "title": "RunSummary", "type": "object" }, "RunsConfig": { "additionalProperties": false, "description": "The `runs` capability: bounds on one response's tool-calling loop.", "properties": { "max_rounds": { "default": 20, "description": "tool rounds allowed per response; also capped by the operator ceiling at use", "minimum": 1, "title": "Max Rounds", "type": "integer" } }, "title": "RunsConfig", "type": "object" }, "S3ConnectorConfig": { "additionalProperties": false, "description": "One S3 bucket, or any S3-compatible endpoint.", "properties": { "access_key_id": { "description": "Access key id", "maxLength": 128, "minLength": 1, "title": "Access Key Id", "type": "string" }, "bucket": { "description": "Bucket name", "maxLength": 255, "minLength": 1, "title": "Bucket", "type": "string" }, "endpoint_url": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "description": "Endpoint for an S3-compatible store; null uses AWS's own for `region`. A host named here must be one of the organisation's allowed hosts at sync time", "title": "Endpoint Url" }, "exclude_path_regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Items whose path matches this are skipped, on top of the built-in media/binary exclusion, which always applies and is never replaced", "title": "Exclude Path Regex" }, "include_path_regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Only items whose path matches this are synced; null matches all", "title": "Include Path Regex" }, "kind": { "const": "s3", "description": "Connector kind", "title": "Kind", "type": "string" }, "prefix": { "default": "", "description": "Only keys under this prefix are synced", "maxLength": 1024, "title": "Prefix", "type": "string" }, "region": { "description": "Region, e.g. eu-west-1", "maxLength": 64, "minLength": 1, "title": "Region", "type": "string" }, "secret_access_key": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "description": "Secret access key; write-only, sealed at rest and never returned", "title": "Secret Access Key" } }, "required": [ "kind", "bucket", "region", "access_key_id" ], "title": "S3ConnectorConfig", "type": "object" }, "SampledSourceRead": { "description": "One source the helper model was shown: what it saw, not what it said.", "properties": { "id": { "description": "The source's id", "title": "Id", "type": "string" }, "title": { "description": "The source's title", "title": "Title", "type": "string" } }, "required": [ "id", "title" ], "title": "SampledSourceRead", "type": "object" }, "ScenarioRead": { "description": "One scenario, as the API returns it.", "properties": { "created_at": { "description": "When the scenario was created", "format": "date-time", "title": "Created At", "type": "string" }, "description": { "description": "Longer note about this conversation", "title": "Description", "type": "string" }, "id": { "description": "Scenario id", "title": "Id", "type": "string" }, "metadata": { "additionalProperties": true, "default": {}, "description": "The opaque document attached to this scenario; {} when none was set", "title": "Metadata", "type": "object" }, "object": { "const": "evaluation.scenario", "default": "evaluation.scenario", "description": "The object's type", "title": "Object", "type": "string" }, "position": { "description": "Order this scenario runs in, unique within the suite", "title": "Position", "type": "integer" }, "steps": { "description": "The steps, in the order they are sent; empty when the publication that shared this suite seals it, which withholds the conversations from every reader while a run still sends them", "items": { "$ref": "#/components/schemas/Step" }, "title": "Steps", "type": "array" }, "title": { "description": "What this conversation tests", "title": "Title", "type": "string" }, "tool_variables": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "values sent as `tool_variables` on every step of this scenario, for the call variables the measured agent's tools declare; a name no tool of a step's turn declares is ignored there. Test data shown to every reader of the suite, so never a secret; empty for a sealed copy", "propertyNames": { "maxLength": 64, "minLength": 1 }, "title": "Tool Variables", "type": "object" }, "updated_at": { "description": "When the scenario was last written", "format": "date-time", "title": "Updated At", "type": "string" }, "variables": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "values sent as `agent.variables` on every step of this scenario, filling in the prompt the measured agent version pins; a name that agent's prompt does not declare is left out of its turn rather than failing it, since one scenario is written for every agent the suite measures; empty for a sealed copy", "title": "Variables", "type": "object" } }, "required": [ "id", "position", "title", "description", "steps", "created_at", "updated_at" ], "title": "ScenarioRead", "type": "object" }, "ScenarioResult": { "additionalProperties": false, "description": "What one scenario of a run did: the thread its steps chained on, and each step's result.", "properties": { "passed": { "description": "whether every step of this scenario passed", "title": "Passed", "type": "boolean" }, "scenario_id": { "description": "the snapshot scenario this result belongs to", "title": "Scenario Id", "type": "string" }, "steps": { "description": "one result per step, in order", "items": { "$ref": "#/components/schemas/StepResult" }, "title": "Steps", "type": "array" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the thread this scenario's steps chained on, when one was made", "title": "Thread Id" } }, "required": [ "scenario_id", "passed" ], "title": "ScenarioResult", "type": "object" }, "ScenarioVersionWrite": { "additionalProperties": false, "description": "One scenario of a version write: the scenario body, plus the id of the scenario it keeps.", "properties": { "description": { "default": "", "description": "Longer note about this conversation", "maxLength": 1024, "title": "Description", "type": "string" }, "id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "the id of a scenario this suite already has, kept with its position; omitted for a new scenario, which takes the next position", "title": "Id" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the scenario, at most 16 KiB serialised: stored, returned and never read by Core. A PUT replaces it whole, like every other field of this body; omitted or null stores {}", "title": "Metadata" }, "steps": { "description": "the steps, in the order they are sent", "items": { "$ref": "#/components/schemas/Step" }, "maxItems": 32, "minItems": 1, "title": "Steps", "type": "array" }, "title": { "description": "What this conversation tests", "maxLength": 256, "title": "Title", "type": "string" }, "tool_variables": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "values sent as `tool_variables` on every step of this scenario, for the call variables the measured agent's tools declare; a name no tool of a step's turn declares is ignored there. Test data shown to every reader of the suite, so never a secret", "propertyNames": { "maxLength": 64, "minLength": 1 }, "title": "Tool Variables", "type": "object" }, "variables": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "values sent as `agent.variables` on every step of this scenario, filling in the prompt the measured agent version pins; a name that agent's prompt does not declare is left out of its turn rather than failing it, since one scenario is written for every agent the suite measures", "title": "Variables", "type": "object" } }, "required": [ "title", "steps" ], "title": "ScenarioVersionWrite", "type": "object" }, "ScenarioWrite": { "additionalProperties": false, "description": "Body of `POST .../scenarios` and `PUT .../scenarios/{id}`: the whole scenario, always.\n\nThere is no per-step route, deliberately: the platform had one and its authors lost edits\nwhenever two of them overlapped, because each write rebuilt the list from a stale copy. One\natomic replace of the whole list is the answer (`docs/architecture/evaluations.md`).\n\n`variables` is part of that whole: the values every step of this scenario sends as\n`agent.variables`, so a name left out of the body is a name the author cleared. They sit on\nthe scenario rather than on a step because one conversation is one persona (the user's\ndecision of 2026-09-16), and the executor narrows them to what each measured agent's own\npinned prompt declares (`app.evaluations.executor`).", "properties": { "description": { "default": "", "description": "Longer note about this conversation", "maxLength": 1024, "title": "Description", "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the scenario, at most 16 KiB serialised: stored, returned and never read by Core. A PUT replaces it whole, like every other field of this body; omitted or null stores {}", "title": "Metadata" }, "steps": { "description": "the steps, in the order they are sent", "items": { "$ref": "#/components/schemas/Step" }, "maxItems": 32, "minItems": 1, "title": "Steps", "type": "array" }, "title": { "description": "What this conversation tests", "maxLength": 256, "title": "Title", "type": "string" }, "tool_variables": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "values sent as `tool_variables` on every step of this scenario, for the call variables the measured agent's tools declare; a name no tool of a step's turn declares is ignored there. Test data shown to every reader of the suite, so never a secret", "propertyNames": { "maxLength": 64, "minLength": 1 }, "title": "Tool Variables", "type": "object" }, "variables": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "values sent as `agent.variables` on every step of this scenario, filling in the prompt the measured agent version pins; a name that agent's prompt does not declare is left out of its turn rather than failing it, since one scenario is written for every agent the suite measures", "title": "Variables", "type": "object" } }, "required": [ "title", "steps" ], "title": "ScenarioWrite", "type": "object" }, "ScheduleCreate": { "additionalProperties": false, "description": "Body of `POST /schedules`: the schedule runs as the key that created it.", "properties": { "at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "the one instant this schedule fires at, after which it disables itself; null for a schedule that fires on `cron`", "title": "At" }, "cron": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "type": "null" } ], "description": "five-field cron expression -- minute hour day-of-month month day-of-week -- read in `timezone`, with `1#1` for the first Monday of a month, `5L` for the last Friday and `L` in day-of-month for the last day; null for a schedule that fires once at `at`", "title": "Cron" }, "description": { "default": "", "description": "What this schedule is for", "maxLength": 1024, "title": "Description", "type": "string" }, "enabled": { "default": true, "description": "whether ticks fire this schedule; a disabled one has no next run", "title": "Enabled", "type": "boolean" }, "evaluation_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "the evaluation suite every fire queues a run of. Required for `kind: evaluation`, and refused for the other kinds", "title": "Evaluation Id" }, "kind": { "default": "response", "description": "what every fire does: `response` sends the stored `request` as one turn, `evaluation` queues a run of the suite `evaluation_id` names, `workflow` starts a run of the workflow `workflow` names", "enum": [ "response", "evaluation", "workflow" ], "title": "Kind", "type": "string" }, "labels": { "default": {}, "description": "the organisation's classification of this schedule, as label -> value", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "an opaque document a caller attaches to the schedule, at most 16 KiB serialised: stored, returned and never read by Core; omitted or null stores {}", "title": "Metadata" }, "name": { "description": "Unique name within the tenant, used to name it", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "title": "Name", "type": "string" }, "request": { "anyOf": [ { "$ref": "#/components/schemas/CreateResponseRequest" }, { "type": "null" } ], "description": "the `POST /responses` body every fire sends, minus `stream`, `background`, `store` and `previous_response_id`, which a fire decides itself. Required for `kind: response`, and refused for the other kinds" }, "run_as_key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "not accepted here: a key schedules as itself. Nominating the key a schedule runs as is the management twin's, whose caller has no key of their own", "title": "Run As Key Id" }, "subject_id": { "anyOf": [ { "pattern": "^[A-Za-z0-9._:@-]{1,128}$", "type": "string" }, { "type": "null" } ], "description": "the person every fired turn is for, stored on what it produces. When the key-facing create or PATCH is her own request through the key the schedule fires as, asserting attributes in X-Core-Subject, they are kept sealed and every fire applies them until subject_attributes_until; written by anyone else, a fire carries the id alone", "title": "Subject Id", "x-core-subject-alias": true }, "timezone": { "default": "UTC", "description": "IANA zone name the `cron` expression is read in, so a summer-time transition moves the fire with the wall clock", "maxLength": 64, "title": "Timezone", "type": "string" }, "workflow": { "anyOf": [ { "pattern": "^[a-z0-9_-]{1,48}$", "type": "string" }, { "type": "null" } ], "description": "the name of the workflow every fire starts a run of, at its latest version. Required for `kind: workflow`, and refused for the other kinds", "title": "Workflow" }, "workflow_input": { "description": "the input every fire starts that run with, held to the workflow's input schema when written and again at every fire. Only for `kind: workflow`", "title": "Workflow Input" } }, "required": [ "name" ], "title": "ScheduleCreate", "type": "object" }, "ScheduleEvaluationFire": { "additionalProperties": false, "description": "What `POST /schedules/{id}/run` answers for a schedule of kind `evaluation`: the runs the\nfire queued, one per agent the suite measures.\n\nA different answer from the other kind's on purpose. A response schedule's fire queues one\nturn and the schedule itself is what a reader wants back -- its clock, its last outcome. An\nevaluation schedule's fire queues several runs at once, and their ids are the only thing a\ncaller cannot look up afterwards without knowing where to start\n(`docs/architecture/evaluations.md`, whose own queue route answers the same ids).", "properties": { "kind": { "const": "evaluation", "default": "evaluation", "description": "The kind of schedule this fire was of", "title": "Kind", "type": "string" }, "object": { "const": "schedule.evaluation_fire", "default": "schedule.evaluation_fire", "description": "The object's type", "title": "Object", "type": "string" }, "run_ids": { "description": "The evaluation runs this fire queued, one per agent the suite measures", "items": { "type": "string" }, "title": "Run Ids", "type": "array" } }, "required": [ "run_ids" ], "title": "ScheduleEvaluationFire", "type": "object" }, "ScheduleObject": { "description": "A schedule, as the API returns it: its clock, its stored request, the identity it fires\nunder, and what its last tick did.", "properties": { "at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The one instant this schedule fires at, or null", "title": "At" }, "created_at": { "description": "When this schedule was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created it: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "cron": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The five-field cron expression, or null for a one-shot", "title": "Cron" }, "description": { "description": "What this schedule is for", "title": "Description", "type": "string" }, "enabled": { "description": "Whether ticks fire this schedule", "title": "Enabled", "type": "boolean" }, "evaluation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The evaluation suite every fire queues a run of; null for a schedule of another kind", "title": "Evaluation Id" }, "id": { "description": "Schedule id", "title": "Id", "type": "string" }, "kind": { "description": "What every fire does: `response` sends the stored request as one turn, `evaluation` queues a run of the suite it names, `workflow` starts a run of the workflow it names", "enum": [ "response", "evaluation", "workflow" ], "title": "Kind", "type": "string" }, "labels": { "default": {}, "description": "The organisation's classification, as label -> value", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "last_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why the last tick failed, as a short kind such as `key_revoked` -- never the text of anything a turn read or produced", "title": "Last Error" }, "last_fired_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When a tick last fired it, or null", "title": "Last Fired At" }, "last_outcome": { "anyOf": [ { "enum": [ "fired", "skipped", "failed" ], "type": "string" }, { "type": "null" } ], "description": "What the last tick did: `fired`, `skipped` while the previous turn was still running, or `failed`", "title": "Last Outcome" }, "last_response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The response the last fire queued, or null -- always null for a schedule of kind `evaluation` or `workflow`, whose fires queue runs", "title": "Last Response Id" }, "last_run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The evaluation run or the workflow run the last fire queued, or null -- always null for a schedule of kind `response`, and the first of the runs when a fire queued several", "title": "Last Run Id" }, "metadata": { "additionalProperties": true, "default": {}, "description": "The opaque document attached to this schedule; {} when none was set", "title": "Metadata", "type": "object" }, "name": { "description": "Unique name within the tenant", "title": "Name", "type": "string" }, "next_run_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the next tick fires this schedule; null while it is disabled, or once a one-shot has fired", "title": "Next Run At" }, "next_runs": { "description": "The next few fire times this schedule's clock produces, in its own zone", "items": { "format": "date-time", "type": "string" }, "title": "Next Runs", "type": "array" }, "object": { "const": "schedule", "default": "schedule", "description": "The object's type", "title": "Object", "type": "string" }, "request": { "anyOf": [ { "$ref": "#/components/schemas/CreateResponseRequest" }, { "type": "null" } ], "description": "The `POST /responses` body every fire sends; null for a schedule of another kind" }, "run_as_key_id": { "description": "The API key every fire rebuilds its reach from; a fire that cannot resolve it records `failed` and leaves the schedule enabled", "title": "Run As Key Id", "type": "string" }, "subject_attributes_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Until when every fire applies the attributes the person asserted when she last wrote this schedule herself; null when fires carry her id alone. Her next write of it moves this on; the attributes themselves are never returned", "title": "Subject Attributes Until" }, "subject_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person every fired turn is for, or null", "title": "Subject Id" }, "timezone": { "description": "The IANA zone the cron expression is read in", "title": "Timezone", "type": "string" }, "tool_variable_secrets": { "additionalProperties": { "$ref": "#/components/schemas/SecretHeld" }, "description": "The names in the stored request's `tool_variables` a tool declares secret (`x-secret`), each answered `{has_value: true}` and never its value; absent from `request`. An update whose request leaves such a name out keeps its value", "title": "Tool Variable Secrets", "type": "object" }, "updated_at": { "description": "When this schedule was last changed", "format": "date-time", "title": "Updated At", "type": "string" }, "workflow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the workflow every fire starts a run of; null for a schedule of another kind", "title": "Workflow" }, "workflow_input": { "description": "The input every fire starts that run with; null for a schedule of another kind", "title": "Workflow Input" } }, "required": [ "id", "name", "description", "cron", "timezone", "at", "enabled", "kind", "request", "evaluation_id", "workflow", "workflow_input", "run_as_key_id", "subject_id", "next_run_at", "last_fired_at", "last_response_id", "last_run_id", "last_outcome", "last_error", "created_by", "created_at", "updated_at" ], "title": "ScheduleObject", "type": "object" }, "SchedulePreview": { "additionalProperties": false, "description": "What `POST /schedules/preview` answers: the next fire times, in the zone asked for.", "properties": { "next_runs": { "description": "The next fire times of the expression, in the zone it was read in", "items": { "format": "date-time", "type": "string" }, "title": "Next Runs", "type": "array" } }, "required": [ "next_runs" ], "title": "SchedulePreview", "type": "object" }, "SchedulePreviewRequest": { "additionalProperties": false, "description": "Body of `POST /schedules/preview`: what a cron expression means, before anything is\nstored. Pure -- it reads nothing and writes nothing -- so an author and an agent can both\ncheck an expression without creating a schedule to find out.", "properties": { "cron": { "description": "The five-field cron expression to read", "maxLength": 256, "title": "Cron", "type": "string" }, "from": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The instant to compute fire times after; now when absent", "title": "From" }, "timezone": { "default": "UTC", "description": "The IANA zone to read the expression in", "maxLength": 64, "title": "Timezone", "type": "string" } }, "required": [ "cron" ], "title": "SchedulePreviewRequest", "type": "object" }, "ScheduleResponseSummary": { "description": "One turn a schedule fired, as its own list returns it: what it is and when it fired,\nnever its output items -- those are read from the response itself, which is the one shape\nthat carries them.", "properties": { "created_at": { "description": "When the fire queued this turn", "format": "date-time", "title": "Created At", "type": "string" }, "id": { "description": "Response id", "title": "Id", "type": "string" }, "status": { "description": "The response's lifecycle state", "enum": [ "queued", "in_progress", "requires_action", "completed", "failed", "cancelled", "incomplete" ], "title": "Status", "type": "string" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The thread this turn ran on, or null", "title": "Thread Id" } }, "required": [ "id", "status", "created_at", "thread_id" ], "title": "ScheduleResponseSummary", "type": "object" }, "ScheduleUpdate": { "additionalProperties": false, "description": "Body of `PATCH /schedules/{id}`: every field optional, and a field left out is left as it\nis. A schedule may switch clocks -- a cron becomes a one-shot and back -- so both fields are\nnullable and the service reads `model_fields_set` to tell \"leave it\" from \"clear it\".", "properties": { "at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "New one-shot instant, or null to switch to a `cron`", "title": "At" }, "cron": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "type": "null" } ], "description": "New cron expression, or null to switch to a one-shot `at`", "title": "Cron" }, "description": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "What this schedule is for", "title": "Description" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether ticks fire this schedule from now on", "title": "Enabled" }, "kind": { "anyOf": [ { "enum": [ "response", "evaluation", "workflow" ], "type": "string" }, { "type": "null" } ], "description": "Not accepted: a schedule's kind is fixed when it is created. Delete this schedule and write the other one, so neither kind's history is reinterpreted", "title": "Kind" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "The organisation's classification of this schedule; {} clears it", "title": "Labels" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "new opaque document, replacing whatever is stored whole; omitted leaves it alone, and {} clears it", "title": "Metadata" }, "name": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "type": "string" }, { "type": "null" } ], "description": "New unique name", "title": "Name" }, "request": { "anyOf": [ { "$ref": "#/components/schemas/CreateResponseRequest" }, { "type": "null" } ], "description": "The `POST /responses` body every fire sends, replaced whole" }, "subject_id": { "anyOf": [ { "pattern": "^[A-Za-z0-9._:@-]{1,128}$", "type": "string" }, { "type": "null" } ], "description": "The person every fired turn is for, or null for nobody in particular", "title": "Subject Id", "x-core-subject-alias": true }, "timezone": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "New IANA zone the `cron` expression is read in", "title": "Timezone" }, "workflow_input": { "description": "The input every fire of a `kind: workflow` schedule starts its run with, replaced whole", "title": "Workflow Input" } }, "title": "ScheduleUpdate", "type": "object" }, "SchedulesConfig": { "additionalProperties": false, "description": "The `schedules` capability: a turn nobody asked for by hand, fired by the worker at a time\nthe organisation set. No configuration, and one dependency -- `runs`, because every fire is a\nbackground run and a key that cannot make one could hold a schedule that fires nothing\n(`docs/architecture/schedules.md`). How often the worker looks is the deployment's setting.", "properties": {}, "title": "SchedulesConfig", "type": "object" }, "ScriptCreate": { "additionalProperties": false, "description": "Body of `POST /scripts`: the script and its version 1.", "properties": { "background": { "anyOf": [ { "$ref": "#/components/schemas/ToolBackground" }, { "type": "null" } ], "description": "whether a turn may start this script as a task, for how long, and whether its call may be sent again after an interruption; omitted means never. Part of the version: a change to it alone writes a new one" }, "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this version reads: a JSON Schema object with one property per variable, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; a call reads the ones declared here from the file `ARTIFIC_VARIABLES` names and the model never sees them. Never a secret: the shell tools can read a script's files; omitted declares none" }, "description": { "description": "What the tool does, shown to the model", "maxLength": 1024, "minLength": 1, "title": "Description", "type": "string" }, "entrypoint": { "description": "The argument list that runs the package from its own directory, such as [\"python3\", \"main.py\"]: 1 to 16 entries, never a shell line", "items": { "type": "string" }, "title": "Entrypoint", "type": "array" }, "files": { "description": "Every file of the package, at most 200 and 20 MiB together", "items": { "$ref": "#/components/schemas/ScriptFileWrite" }, "title": "Files", "type": "array" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/InstallValue" }, "description": "The values this version's author sets, by name: `{type, value, allowed, description}` with `type` one of `string`, `number` and `enum`, never a secret. A call reads them from the file `ARTIFIC_INSTALL` names; a marketplace install asks for each as a parameter. A name may not also be an argument or a call variable; omitted declares none", "title": "Install Values", "type": "object" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "The organisation's classification of this script, as label -> value; what the rules over `tool` read. Omitted on a new version keeps the script's", "title": "Labels" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the script, at most 16 KiB: stored, returned and never read by Core. Omitted on a new version keeps the script's", "title": "Metadata" }, "name": { "description": "Script name, unique per organisation and never changed; the model sees `script__`", "pattern": "^[a-z0-9_-]{1,48}$", "title": "Name", "type": "string" }, "packages": { "description": "The approved packages the package needs, every one of them, dependencies included: at most 32, each on the deployment's or the organisation's list", "items": { "$ref": "#/components/schemas/PackageName" }, "title": "Packages", "type": "array" }, "parameters": { "additionalProperties": true, "description": "JSON Schema object (Draft 2020-12, at most 64 KiB) the call's arguments must satisfy", "title": "Parameters", "type": "object" }, "timeout_seconds": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "How long one call may run, never longer than the key's own limit; null takes that limit", "title": "Timeout Seconds" } }, "required": [ "description", "entrypoint", "files", "name" ], "title": "ScriptCreate", "type": "object" }, "ScriptFileRead": { "description": "One file of a version, as a read answers it.", "properties": { "path": { "description": "Where the file sits in the package", "title": "Path", "type": "string" }, "sha256": { "description": "SHA-256 hex digest of the file's bytes", "title": "Sha256", "type": "string" }, "size_bytes": { "description": "The file's length in bytes", "title": "Size Bytes", "type": "integer" } }, "required": [ "path", "size_bytes", "sha256" ], "title": "ScriptFileRead", "type": "object" }, "ScriptFileWrite": { "additionalProperties": false, "description": "One file of a package: text written in the body, or an upload the caller already made.", "properties": { "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The file's UTF-8 text; give this or `file_id`, never both", "title": "Content" }, "file_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "An upload this caller may read (`POST /files`), copied into the version; for binary assets and anything large", "title": "File Id" }, "path": { "description": "Where the file sits in the package, relative, such as `main.py` or `lib/deck.py`; at most 255 characters, no `..`, NUL or backslash", "maxLength": 1024, "title": "Path", "type": "string" } }, "required": [ "path" ], "title": "ScriptFileWrite", "type": "object" }, "ScriptPackageRead": { "description": "One package a script version names, as it resolved when the version was written.", "properties": { "approval": { "description": "Which list approved it when the version was written, or `bundle` for a package the publication that installed this copy carried, installed for it alone", "enum": [ "image", "deployment", "organisation", "bundle" ], "title": "Approval", "type": "string" }, "ecosystem": { "description": "`pypi` or `npm`", "title": "Ecosystem", "type": "string" }, "name": { "description": "The package's name, normalised", "title": "Name", "type": "string" }, "sha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The approved file's digest the version pinned; null for an image package", "title": "Sha256" }, "version": { "description": "The exact version", "title": "Version", "type": "string" } }, "required": [ "ecosystem", "name", "version", "approval", "sha256" ], "title": "ScriptPackageRead", "type": "object" }, "ScriptRead": { "description": "One script, with its latest version's fields flat and that version's number.", "properties": { "background": { "anyOf": [ { "$ref": "#/components/schemas/ToolBackground" }, { "type": "null" } ], "description": "Whether the latest version may be started as a task; null is never" }, "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The latest version's call variables: The call variables this version reads: a JSON Schema object with one property per variable, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; a call reads the ones declared here from the file `ARTIFIC_VARIABLES` names and the model never sees them. Never a secret: the shell tools can read a script's files. A sealed copy answers them too, because a caller must know what to send" }, "created_at": { "description": "When this script was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created this script", "title": "Created By", "type": "string" }, "description": { "description": "What the tool does, from the latest version", "title": "Description", "type": "string" }, "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "entrypoint": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The latest version's argument list; null for a sealed copy, which withholds it", "title": "Entrypoint" }, "files": { "description": "The latest version's files; empty for a sealed copy", "items": { "$ref": "#/components/schemas/ScriptFileRead" }, "title": "Files", "type": "array" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "id": { "description": "Script id", "title": "Id", "type": "string" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/InstallValue" }, "description": "The latest version's install values: The values this version's author sets, by name: `{type, value, allowed, description}` with `type` one of `string`, `number` and `enum`, never a secret. A call reads them from the file `ARTIFIC_INSTALL` names; a marketplace install asks for each as a parameter. A name may not also be an argument or a call variable", "title": "Install Values", "type": "object" }, "labels": { "description": "The organisation's classification of this script", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "additionalProperties": true, "description": "The opaque document attached; {} when none", "title": "Metadata", "type": "object" }, "name": { "description": "Script name; the model sees `script__`", "title": "Name", "type": "string" }, "object": { "const": "script", "default": "script", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/OriginRead" }, { "type": "null" } ], "description": "Where this script came from when a subscription installed it; null for one this organisation wrote itself" }, "packages": { "description": "The approved packages the latest version needs", "items": { "$ref": "#/components/schemas/ScriptPackageRead" }, "title": "Packages", "type": "array" }, "parameters": { "additionalProperties": true, "description": "The latest version's argument schema", "title": "Parameters", "type": "object" }, "state": { "default": "published", "description": "The state of the version this read repeats: `draft` only on the management twin, for a script with nothing published", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "timeout_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The latest version's timeout; null is the key's", "title": "Timeout Seconds" }, "updated_at": { "description": "When this script last gained a version", "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "description": "This script's latest published version number, whose fields this read repeats; on the management twin, its newest draft's while nothing is published", "title": "Version", "type": "integer" } }, "required": [ "id", "name", "description", "parameters", "entrypoint", "files", "packages", "timeout_seconds", "background", "install_values", "call_variables", "version", "labels", "metadata", "created_by", "created_at", "updated_at" ], "title": "ScriptRead", "type": "object" }, "ScriptVersionCreate": { "additionalProperties": false, "description": "Body of `POST /scripts/{script_id}/versions`: the whole package of the next version.", "properties": { "background": { "anyOf": [ { "$ref": "#/components/schemas/ToolBackground" }, { "type": "null" } ], "description": "whether a turn may start this script as a task, for how long, and whether its call may be sent again after an interruption; omitted means never. Part of the version: a change to it alone writes a new one" }, "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this version reads: a JSON Schema object with one property per variable, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; a call reads the ones declared here from the file `ARTIFIC_VARIABLES` names and the model never sees them. Never a secret: the shell tools can read a script's files; omitted declares none" }, "description": { "description": "What the tool does, shown to the model", "maxLength": 1024, "minLength": 1, "title": "Description", "type": "string" }, "entrypoint": { "description": "The argument list that runs the package from its own directory, such as [\"python3\", \"main.py\"]: 1 to 16 entries, never a shell line", "items": { "type": "string" }, "title": "Entrypoint", "type": "array" }, "files": { "description": "Every file of the package, at most 200 and 20 MiB together", "items": { "$ref": "#/components/schemas/ScriptFileWrite" }, "title": "Files", "type": "array" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/InstallValue" }, "description": "The values this version's author sets, by name: `{type, value, allowed, description}` with `type` one of `string`, `number` and `enum`, never a secret. A call reads them from the file `ARTIFIC_INSTALL` names; a marketplace install asks for each as a parameter. A name may not also be an argument or a call variable; omitted declares none", "title": "Install Values", "type": "object" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "The organisation's classification of this script, as label -> value; what the rules over `tool` read. Omitted on a new version keeps the script's", "title": "Labels" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the script, at most 16 KiB: stored, returned and never read by Core. Omitted on a new version keeps the script's", "title": "Metadata" }, "packages": { "description": "The approved packages the package needs, every one of them, dependencies included: at most 32, each on the deployment's or the organisation's list", "items": { "$ref": "#/components/schemas/PackageName" }, "title": "Packages", "type": "array" }, "parameters": { "additionalProperties": true, "description": "JSON Schema object (Draft 2020-12, at most 64 KiB) the call's arguments must satisfy", "title": "Parameters", "type": "object" }, "timeout_seconds": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "How long one call may run, never longer than the key's own limit; null takes that limit", "title": "Timeout Seconds" } }, "required": [ "description", "entrypoint", "files" ], "title": "ScriptVersionCreate", "type": "object" }, "ScriptVersionRead": { "description": "One version of a script's package.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "background": { "anyOf": [ { "$ref": "#/components/schemas/ToolBackground" }, { "type": "null" } ], "description": "Whether this version may be started as a task; null is never" }, "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this version reads: a JSON Schema object with one property per variable, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; a call reads the ones declared here from the file `ARTIFIC_VARIABLES` names and the model never sees them. Never a secret: the shell tools can read a script's files. A sealed copy answers them too, because a caller must know what to send" }, "created_at": { "description": "When this version was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created this version", "title": "Created By", "type": "string" }, "description": { "description": "What the tool does, shown to the model", "title": "Description", "type": "string" }, "entrypoint": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The argument list that runs the package; null for a copy a sealed publication installed, which withholds it", "title": "Entrypoint" }, "files": { "description": "Every file of the package; empty for a copy a sealed publication installed", "items": { "$ref": "#/components/schemas/ScriptFileRead" }, "title": "Files", "type": "array" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/InstallValue" }, "description": "The values this version's author sets, by name: `{type, value, allowed, description}` with `type` one of `string`, `number` and `enum`, never a secret. A call reads them from the file `ARTIFIC_INSTALL` names; a marketplace install asks for each as a parameter. A name may not also be an argument or a call variable", "title": "Install Values", "type": "object" }, "object": { "const": "script_version", "default": "script_version", "description": "The object's type", "title": "Object", "type": "string" }, "packages": { "description": "The approved packages it needs, each as it resolved when it was written", "items": { "$ref": "#/components/schemas/ScriptPackageRead" }, "title": "Packages", "type": "array" }, "parameters": { "additionalProperties": true, "description": "JSON Schema object for the call's arguments", "title": "Parameters", "type": "object" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "script_id": { "description": "Script this version belongs to", "title": "Script Id", "type": "string" }, "state": { "default": "published", "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "timeout_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "How long one call may run; null is the key's", "title": "Timeout Seconds" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" } }, "required": [ "script_id", "version", "description", "parameters", "entrypoint", "files", "packages", "timeout_seconds", "background", "install_values", "call_variables", "created_by", "acted_for", "created_at" ], "title": "ScriptVersionRead", "type": "object" }, "SearchHighlight": { "description": "One stretch of a snippet that matched the words searched for, in UTF-16 code units: the\nunit a JavaScript string is indexed in, so `snippet.slice(start, end)` is the match.", "properties": { "end": { "description": "offset in `snippet`, in UTF-16 code units, just past the last that matched", "title": "End", "type": "integer" }, "start": { "description": "offset in `snippet`, in UTF-16 code units, of the first unit that matched", "title": "Start", "type": "integer" } }, "required": [ "start", "end" ], "title": "SearchHighlight", "type": "object" }, "SearchRequest": { "additionalProperties": false, "description": "Body of `POST /knowledge/indexes/{index_id}/search`.", "properties": { "metadata": { "additionalProperties": { "type": "string" }, "description": "Metadata filter, matched by JSONB containment", "title": "Metadata", "type": "object" }, "query": { "description": "Search query text, at most 4096 characters", "maxLength": 4096, "minLength": 1, "title": "Query", "type": "string" }, "top_k": { "default": 5, "description": "Maximum hits to return", "maximum": 50.0, "minimum": 1.0, "title": "Top K", "type": "integer" } }, "required": [ "query" ], "title": "SearchRequest", "type": "object" }, "SearchSettings": { "additionalProperties": false, "description": "Signals a memory search uses beyond keyword and meaning.", "properties": { "graph_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "knowledge graph whose entities, matched against the query, rank the records that name them as a third signal; null uses none", "title": "Graph Id" }, "rerank": { "anyOf": [ { "$ref": "#/components/schemas/RerankSettings" }, { "type": "null" } ], "description": "reranking pass over the fused results; null reranks nothing" } }, "title": "SearchSettings", "type": "object" }, "SecretHeld": { "description": "A secret value a schedule holds, answered by its presence alone.", "properties": { "has_value": { "const": true, "description": "always true: the value is held, never shown", "title": "Has Value", "type": "boolean" } }, "required": [ "has_value" ], "title": "SecretHeld", "type": "object" }, "SecretInstallValue": { "additionalProperties": false, "description": "A secret install value as it is written: its text, sealed and never read back.", "properties": { "description": { "default": "", "description": "what this value is for, shown to whoever sets it", "maxLength": 1024, "title": "Description", "type": "string" }, "type": { "const": "secret", "description": "secret", "title": "Type", "type": "string" }, "value": { "description": "the secret's text, written once and never read back", "maxLength": 8192, "minLength": 1, "title": "Value", "type": "string" } }, "required": [ "type", "value" ], "title": "SecretInstallValue", "type": "object" }, "SecretInstallValueRead": { "description": "A secret install value as every read answers it: whether there is one, never its text.", "properties": { "description": { "default": "", "description": "what this value is for", "title": "Description", "type": "string" }, "has_value": { "description": "whether a value is held; it is never answered", "title": "Has Value", "type": "boolean" }, "type": { "const": "secret", "description": "secret", "title": "Type", "type": "string" } }, "required": [ "type", "has_value" ], "title": "SecretInstallValueRead", "type": "object" }, "ServiceAccountCreate": { "additionalProperties": false, "description": "Body of `POST /service-accounts` and its twin: the account, and the key it owns.", "properties": { "agent": { "description": "The name of the stored agent the account runs; its key requires that agent on every turn", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "title": "Agent", "type": "string" }, "attributes": { "description": "The attributes Core applies to everything the account does, as name -> value or list of values, held to the organisation's vocabulary; names beginning `core.` are Core's and refused", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "type": "array" } ] } }, "title": "Attributes", "type": "object" }, "capabilities": { "additionalProperties": { "additionalProperties": true, "type": "object" }, "description": "Capability configs the account's key enables, as on a key; `management` and `subjects` are refused", "title": "Capabilities", "type": "object" }, "description": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "description": "What the account is for", "title": "Description" }, "instructors": { "description": "Who may hand the account work besides management; empty is management only", "items": { "$ref": "#/components/schemas/InstructorEntry" }, "maxItems": 32, "title": "Instructors", "type": "array" }, "monthly_cost_cap_eur": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Ceiling on what the account's key may spend in a calendar month (UTC), in euro; null is no cap", "title": "Monthly Cost Cap Eur" }, "monthly_cost_cap_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the account key's monthly cap stops binding: only the end of the current cap period, the first instant of next month at 00:00:00 UTC; any other instant, or one with no cap to end, is 422. Null or omitted, the cap is standing", "title": "Monthly Cost Cap Until" }, "name": { "description": "Unique in the organisation and fixed once written: the account's subject id is `sa:`", "pattern": "^[a-z0-9][a-z0-9-]{0,62}$", "title": "Name", "type": "string" }, "policy": { "$ref": "#/components/schemas/PolicyDocument", "description": "The policy document the account's key calls under. Core replaces its rules over `agent` with one permitting the account's agent and sets `agents_required`" } }, "required": [ "name", "agent" ], "title": "ServiceAccountCreate", "type": "object" }, "ServiceAccountIssued": { "description": "The account at the one moment its key's secret exists outside Core: the create's answer.", "properties": { "agent": { "description": "The name of the stored agent the account runs", "title": "Agent", "type": "string" }, "attributes": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "description": "The attributes Core applies to everything the account does", "title": "Attributes", "type": "object" }, "created_at": { "description": "When the account was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created the account: a key id or `operator:`", "title": "Created By", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "What the account is for", "title": "Description" }, "id": { "description": "Service account id", "title": "Id", "type": "string" }, "instructors": { "description": "Who may hand the account work besides management", "items": { "$ref": "#/components/schemas/InstructorEntry" }, "title": "Instructors", "type": "array" }, "key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The account's own key; null only while a deletion takes it away", "title": "Key Id" }, "mail_send": { "description": "Whether turns for the account may send from its mailbox", "title": "Mail Send", "type": "boolean" }, "mail_watch": { "description": "Whether the worker watches the account's mailbox", "title": "Mail Watch", "type": "boolean" }, "mailbox": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the mail connector that is the account's own mailbox; null for none", "title": "Mailbox" }, "name": { "description": "The account's name, fixed once written", "title": "Name", "type": "string" }, "object": { "const": "service_account", "default": "service_account", "description": "The object's type", "title": "Object", "type": "string" }, "secret": { "description": "The account key's secret, returned exactly once; Core keeps only its hash", "title": "Secret", "type": "string" }, "status": { "description": "`active`, `paused` or `deleting`", "title": "Status", "type": "string" }, "subject_id": { "description": "The account's reserved subject id, `sa:`", "title": "Subject Id", "type": "string" }, "tenant_id": { "description": "Owning organisation id", "title": "Tenant Id", "type": "string" }, "updated_at": { "description": "When the account was last changed", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "name", "subject_id", "agent", "description", "attributes", "instructors", "status", "key_id", "mailbox", "mail_watch", "mail_send", "created_by", "created_at", "updated_at", "secret" ], "title": "ServiceAccountIssued", "type": "object" }, "ServiceAccountRead": { "description": "A service account, as every route but the create answers it.", "properties": { "agent": { "description": "The name of the stored agent the account runs", "title": "Agent", "type": "string" }, "attributes": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "description": "The attributes Core applies to everything the account does", "title": "Attributes", "type": "object" }, "created_at": { "description": "When the account was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created the account: a key id or `operator:`", "title": "Created By", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "What the account is for", "title": "Description" }, "id": { "description": "Service account id", "title": "Id", "type": "string" }, "instructors": { "description": "Who may hand the account work besides management", "items": { "$ref": "#/components/schemas/InstructorEntry" }, "title": "Instructors", "type": "array" }, "key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The account's own key; null only while a deletion takes it away", "title": "Key Id" }, "mail_send": { "description": "Whether turns for the account may send from its mailbox", "title": "Mail Send", "type": "boolean" }, "mail_watch": { "description": "Whether the worker watches the account's mailbox", "title": "Mail Watch", "type": "boolean" }, "mailbox": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the mail connector that is the account's own mailbox; null for none", "title": "Mailbox" }, "name": { "description": "The account's name, fixed once written", "title": "Name", "type": "string" }, "object": { "const": "service_account", "default": "service_account", "description": "The object's type", "title": "Object", "type": "string" }, "status": { "description": "`active`, `paused` or `deleting`", "title": "Status", "type": "string" }, "subject_id": { "description": "The account's reserved subject id, `sa:`", "title": "Subject Id", "type": "string" }, "tenant_id": { "description": "Owning organisation id", "title": "Tenant Id", "type": "string" }, "updated_at": { "description": "When the account was last changed", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "name", "subject_id", "agent", "description", "attributes", "instructors", "status", "key_id", "mailbox", "mail_watch", "mail_send", "created_by", "created_at", "updated_at" ], "title": "ServiceAccountRead", "type": "object" }, "ServiceAccountRun": { "description": "One response the account ran, as its run list returns it: what it is, what fired it and who\nhanded it over, never its output items -- `GET /responses/{id}` is the one shape that carries\nthem (`docs/architecture/service-accounts.md#runs`).", "properties": { "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the run reached a terminal status; null while it has not", "title": "Completed At" }, "created_at": { "description": "When the run was created", "format": "date-time", "title": "Created At", "type": "string" }, "id": { "description": "Response id", "title": "Id", "type": "string" }, "instructed_by_key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The key that handed the run to the account; null with a null subject for work nobody handed over (a schedule, a trigger, the account's own key)", "title": "Instructed By Key Id" }, "instructed_by_subject_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the instructing request named, when it named one", "title": "Instructed By Subject Id" }, "schedule_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The schedule whose fire produced the run; null for a run a caller asked for, and once that schedule is deleted", "title": "Schedule Id" }, "status": { "description": "The response's lifecycle state", "enum": [ "queued", "in_progress", "requires_action", "completed", "failed", "cancelled", "incomplete" ], "title": "Status", "type": "string" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The thread the run ran on, or null", "title": "Thread Id" } }, "required": [ "id", "status", "created_at", "completed_at", "thread_id", "schedule_id", "instructed_by_key_id", "instructed_by_subject_id" ], "title": "ServiceAccountRun", "type": "object" }, "ServiceAccountSummary": { "description": "An account's activity over a window, in total and per instructor: a read over the usage and\naudit rows whose subject is the account (`docs/architecture/service-accounts.md#overview`).", "properties": { "by_instructor": { "description": "The same figures per instructor, the most costly first", "items": { "$ref": "#/components/schemas/InstructorSummary" }, "title": "By Instructor", "type": "array" }, "cost_eur": { "description": "What the account's work cost in the window, in euro", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Cost Eur", "type": "string" }, "from": { "description": "Start of the window, inclusive", "format": "date-time", "title": "From", "type": "string" }, "last_activity_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The latest usage or audit row in the window; null for none", "title": "Last Activity At" }, "mails_sent": { "description": "Mails the account's own mailbox handed to its server", "title": "Mails Sent", "type": "integer" }, "refusals": { "description": "Denied policy decisions recorded for the account", "title": "Refusals", "type": "integer" }, "service_account_id": { "description": "Service account id", "title": "Service Account Id", "type": "string" }, "subject_id": { "description": "The account's subject id, `sa:`", "title": "Subject Id", "type": "string" }, "to": { "description": "End of the window, exclusive", "format": "date-time", "title": "To", "type": "string" }, "turns": { "description": "Responses the account ran in the window", "title": "Turns", "type": "integer" }, "unpriced": { "description": "Usage rows no price covered, counted as zero in `cost_eur`", "title": "Unpriced", "type": "integer" } }, "required": [ "service_account_id", "subject_id", "from", "to", "turns", "cost_eur", "unpriced", "refusals", "mails_sent", "last_activity_at", "by_instructor" ], "title": "ServiceAccountSummary", "type": "object" }, "ServiceAccountUpdate": { "additionalProperties": false, "description": "Body of `PATCH /service-accounts/{id}`: absent fields are left alone. The name is fixed.", "properties": { "agent": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "type": "string" }, { "type": "null" } ], "description": "Another stored agent for the account to run; its key's rule over `agent` follows", "title": "Agent" }, "attributes": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "type": "array" } ] } }, "type": "object" }, { "type": "null" } ], "description": "Replaces the account's attributes whole; they apply from the next request and the next pickup of every piece of its work", "title": "Attributes" }, "description": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "description": "What the account is for", "title": "Description" }, "instructors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/InstructorEntry" }, "maxItems": 32, "type": "array" }, { "type": "null" } ], "description": "Replaces the account's instruct list whole; empty is management only", "title": "Instructors" }, "mail_send": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether turns for the account may send from its mailbox, under its connector version's sending rules; needs a `mailbox`", "title": "Mail Send" }, "mail_watch": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the worker watches the account's mailbox for new mail, with its connector version's `watch`; needs a `mailbox`", "title": "Mail Watch" }, "mailbox": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "The id of the mail connector that is the account's own mailbox: one of kind `oauth_authorization_code` on which the account holds a grant. An explicit null clears it and switches `mail_watch` and `mail_send` off", "title": "Mailbox" } }, "title": "ServiceAccountUpdate", "type": "object" }, "ShareLinkCreate": { "additionalProperties": false, "description": "Body of `POST …/links`; every field is optional.", "properties": { "expires_in_days": { "anyOf": [ { "maximum": 365.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "How many days the link opens the page for. Absent is the longest the organisation's and the key's `settings.share_link_max_days` allow, 30 days where neither names any; more than that is `422`", "title": "Expires In Days" } }, "title": "ShareLinkCreate", "type": "object" }, "ShareLinkRead": { "description": "One share link: the address that opens a stored HTML file to whoever holds it, with no\ncredential, until it expires or is revoked.", "properties": { "closed": { "description": "Whether the link stopped opening the page because the key that made it was deleted or has expired. A closed link has no `url` and stays listed until it is revoked; a link a person made is never closed this way", "title": "Closed", "type": "boolean" }, "created_at": { "description": "When this link was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created this link", "title": "Created By", "type": "string" }, "expired": { "description": "Whether the link has already stopped opening the page because its time ran out; an expired link stays listed until it is revoked or its file is deleted", "title": "Expired", "type": "boolean" }, "expires_at": { "description": "When the link stops opening the page", "format": "date-time", "title": "Expires At", "type": "string" }, "file_id": { "description": "The stored file or artifact the link opens; for a link on a page, the file of the version the page shows now", "title": "File Id", "type": "string" }, "id": { "description": "Share link id", "title": "Id", "type": "string" }, "object": { "const": "share_link", "default": "share_link", "description": "The object's type", "title": "Object", "type": "string" }, "page_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The page the link opens, at whichever version is current when it is viewed; null for a link on a file", "title": "Page Id" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Address that serves the page to whoever opens it, with no credential. It is sealed again on every read, so two reads spell it differently and both open the same link; treat it as a secret. Null for a caller who could not make this link now -- one whose policy does not allow share links, or does not allow downloading the artifact -- who can still read the link and revoke it, and for a link that is `closed`", "title": "Url" } }, "required": [ "id", "url", "file_id", "page_id", "expires_at", "expired", "closed", "created_by", "created_at" ], "title": "ShareLinkRead", "type": "object" }, "SharePointConnectorConfig": { "additionalProperties": false, "description": "One SharePoint site's document libraries, over the Microsoft Graph API.", "properties": { "client_id": { "description": "Entra ID application id", "maxLength": 128, "minLength": 1, "title": "Client Id", "type": "string" }, "client_secret": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "description": "Application secret; write-only, sealed at rest and never returned", "title": "Client Secret" }, "exclude_path_regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Items whose path matches this are skipped, on top of the built-in media/binary exclusion, which always applies and is never replaced", "title": "Exclude Path Regex" }, "include_path_regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Only items whose path matches this are synced; null matches all", "title": "Include Path Regex" }, "include_site_pages": { "default": true, "description": "Also sync the site's own .aspx pages", "title": "Include Site Pages", "type": "boolean" }, "kind": { "const": "sharepoint", "description": "Connector kind", "title": "Kind", "type": "string" }, "site_url": { "description": "Site URL, e.g. https://contoso.sharepoint.com/sites/Docs", "maxLength": 2048, "minLength": 1, "title": "Site Url", "type": "string" }, "tenant_id": { "description": "Entra ID tenant id", "maxLength": 128, "minLength": 1, "title": "Tenant Id", "type": "string" } }, "required": [ "kind", "site_url", "tenant_id", "client_id" ], "title": "SharePointConnectorConfig", "type": "object" }, "SignInProviderRead": { "description": "One sign-in provider of this organisation.", "properties": { "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The client registered at the provider", "title": "Client Id" }, "directory_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "For `entra`, the one directory whose accounts may sign in", "title": "Directory Id" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "What the sign-in page calls this provider", "title": "Display Name" }, "enabled": { "description": "Whether people may sign in through this provider", "title": "Enabled", "type": "boolean" }, "hosted_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "For `google`, the one Workspace domain whose accounts may sign in", "title": "Hosted Domain" }, "issuer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The issuer every ID token from this provider is held to", "title": "Issuer" }, "kind": { "description": "Which kind of provider this is", "enum": [ "oidc", "google", "entra" ], "title": "Kind", "type": "string" }, "name": { "description": "This provider's name within its organisation", "title": "Name", "type": "string" }, "object": { "const": "sign_in_provider", "default": "sign_in_provider", "description": "The object's type", "title": "Object", "type": "string" }, "redirect_uri": { "description": "The redirect URI to register on the client at the provider", "title": "Redirect Uri", "type": "string" }, "sign_in_hint": { "description": "What a sign-in link names to send a person straight to this provider rather than to the password form. The sign-in page itself lists no organisation's provider", "title": "Sign In Hint", "type": "string" } }, "required": [ "name", "kind", "issuer", "hosted_domain", "directory_id", "client_id", "display_name", "enabled", "sign_in_hint", "redirect_uri" ], "title": "SignInProviderRead", "type": "object" }, "SkillRead": { "description": "A skill package, as the API returns it. Never carries `description_embedding`: an\ninternal retrieval detail, not part of the identity a caller acts on.", "properties": { "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The skill's instructions: SKILL.md's body, front matter stripped; null when the publication that shared this skill withholds its content ('sealed'), which a turn still loads unchanged", "title": "Body" }, "created_at": { "description": "When the skill was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created the skill: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "description": { "description": "Short description of what the skill does", "title": "Description", "type": "string" }, "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "id": { "description": "Skill id", "title": "Id", "type": "string" }, "labels": { "default": {}, "description": "The organisation's classification of this skill, as label -> value", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "latest_version": { "description": "Version number of the highest published version, whose content this read repeats; on the management twin, 0 for a skill with only drafts, whose newest draft this read then repeats", "title": "Latest Version", "type": "integer" }, "metadata": { "additionalProperties": true, "default": {}, "description": "The opaque document attached to this skill; {} when none was set", "title": "Metadata", "type": "object" }, "name": { "description": "Unique name within the tenant (^[a-z0-9]+(-[a-z0-9]+)*$)", "title": "Name", "type": "string" }, "object": { "const": "skill", "default": "skill", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/OriginRead" }, { "type": "null" } ], "description": "The subscription that installed this skill, and the publication it came from; null for a skill this organisation wrote itself" }, "resources": { "description": "Packaged resource files: path and size", "items": { "$ref": "#/components/schemas/SkillResourceSummary" }, "title": "Resources", "type": "array" }, "updated_at": { "description": "When the skill was last replaced", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "name", "description", "body", "resources", "latest_version", "created_by", "created_at", "updated_at" ], "title": "SkillRead", "type": "object" }, "SkillResourceRead": { "description": "One packaged resource's content, as `GET /skills/{skill_id}/resources/{path}` returns it.", "properties": { "content": { "description": "The resource file's text content", "title": "Content", "type": "string" }, "path": { "description": "The resource's path within the skill package", "title": "Path", "type": "string" } }, "required": [ "path", "content" ], "title": "SkillResourceRead", "type": "object" }, "SkillResourceSummary": { "description": "One packaged resource's path and size, as listed on `SkillRead`.", "properties": { "bytes": { "description": "Size of the resource's content in bytes", "title": "Bytes", "type": "integer" }, "path": { "description": "The resource's path within the skill package", "title": "Path", "type": "string" } }, "required": [ "path", "bytes" ], "title": "SkillResourceSummary", "type": "object" }, "SkillVersionRead": { "description": "One immutable version of a skill's package, as the API returns it. Never carries\n`description_embedding`, as `SkillRead` does not.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The skill's instructions as this version had them; null when the publication that shared this skill withholds its content ('sealed'), which a turn still loads unchanged", "title": "Body" }, "created_at": { "description": "When this version was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created the version: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "description": { "description": "Short description of what the skill does", "title": "Description", "type": "string" }, "id": { "description": "Skill version id", "title": "Id", "type": "string" }, "object": { "const": "skill_version", "default": "skill_version", "description": "The object's type", "title": "Object", "type": "string" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "resources": { "description": "Packaged resource files: path and size; none for a sealed version", "items": { "$ref": "#/components/schemas/SkillResourceSummary" }, "title": "Resources", "type": "array" }, "sealed": { "default": false, "description": "Whether this version was installed under sealed terms, so its content is withheld here for good -- whatever a later version of the same copy says, and after a fork. A version this organisation wrote itself is never sealed", "title": "Sealed", "type": "boolean" }, "skill_id": { "description": "Owning skill id", "title": "Skill Id", "type": "string" }, "state": { "default": "published", "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" } }, "required": [ "id", "skill_id", "version", "description", "body", "resources", "created_by", "acted_for", "created_at" ], "title": "SkillVersionRead", "type": "object" }, "SkillWrite": { "additionalProperties": false, "description": "Body of `POST /skills` and `PUT /skills/{skill_id}`: a SKILL.md file plus the text files\npackaged alongside it.", "properties": { "labels": { "default": {}, "description": "The organisation's classification of this skill, as label -> value; what the rules over `skill` read. A PUT replaces them, like every other field of this body", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the skill, at most 16 KiB serialised: stored, returned and never read by Core. A PUT replaces it whole, like every other field of this body; omitted or null stores {}", "title": "Metadata" }, "resources": { "description": "Text files packaged alongside the skill", "items": { "$ref": "#/components/schemas/ResourceIn" }, "title": "Resources", "type": "array" }, "skill_md": { "description": "The SKILL.md file: '---' front matter (name, description) then a markdown body", "maxLength": 70000, "title": "Skill Md", "type": "string" } }, "required": [ "skill_md" ], "title": "SkillWrite", "type": "object" }, "SkillsConfig": { "additionalProperties": false, "description": "The `skills` capability: how skills are selected for a run.", "properties": { "min_score": { "default": 0.2, "description": "minimum retrieval score for a skill to load", "maximum": 1, "minimum": 0, "title": "Min Score", "type": "number" }, "retrieval_top_k": { "default": 3, "description": "skills retrieval returns, when selection=retrieval", "maximum": 10, "minimum": 1, "title": "Retrieval Top K", "type": "integer" }, "selection": { "default": "model", "description": "whether the model or retrieval picks which skills load", "enum": [ "model", "retrieval" ], "title": "Selection", "type": "string" } }, "title": "SkillsConfig", "type": "object" }, "SourceAuthRead": { "description": "What a read model says about a source's credential: its kind, the non-secret fields of that\nkind, and whether sealed bytes exist -- never the secret itself.\n\nOne flat shape rather than a union, because a console renders one section per kind and a\ncaller asking \"is anything stored\" should not have to discriminate first. Every field a kind\ndoes not have is null.", "properties": { "audience": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Audience of a client-credentials or authorization-code credential; null otherwise", "title": "Audience" }, "authorize_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Endpoint a person's own browser is sent to for an authorization-code credential; null for other kinds", "title": "Authorize Url" }, "client": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the deployment's own OAuth application this authorization-code credential uses instead of client fields of its own; null for every other kind and for one carrying its own", "title": "Client" }, "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Client id of a client-credentials or authorization-code credential; null otherwise", "title": "Client Id" }, "has_secret": { "description": "Whether a credential is stored for this source. False for an authorization-code credential registered as a public client, which has no secret to store and authenticates with PKCE alone", "title": "Has Secret", "type": "boolean" }, "header_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Header a bearer credential is sent in; null for other kinds", "title": "Header Name" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Header name or query key of an api_key credential; null otherwise", "title": "Name" }, "placement": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "`header` or `query` for an api_key credential; null otherwise", "title": "Placement" }, "scopes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Scopes of a client-credentials or authorization-code credential; null for other kinds", "title": "Scopes" }, "token_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Token endpoint of a client-credentials or authorization-code credential; null otherwise", "title": "Token Url" }, "type": { "description": "How this source authenticates: one of `none`, `bearer`, `api_key`, `basic`, `oauth_client_credentials`, `oauth_authorization_code`", "title": "Type", "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "User half of a basic credential; null otherwise", "title": "Username" } }, "required": [ "type", "has_secret" ], "title": "SourceAuthRead", "type": "object" }, "SourceGraphStateRead": { "description": "One `(source, graph)` pair's ingestion state, as `GET /knowledge/graphs/{id}/sources`\nreturns it.", "properties": { "collection_id": { "description": "The collection the source belongs to", "title": "Collection Id", "type": "string" }, "epoch": { "description": "The graph epoch this ingestion ran under", "title": "Epoch", "type": "integer" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Fixed failure code, when status is 'failed'", "title": "Error Code" }, "fact_count": { "description": "Entities and relations this source asserted, once ready", "title": "Fact Count", "type": "integer" }, "graph_id": { "description": "The graph it is being read into", "title": "Graph Id", "type": "string" }, "object": { "const": "knowledge_source_graph", "default": "knowledge_source_graph", "description": "The object's type", "title": "Object", "type": "string" }, "parked_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Set on a 'queued' pair whose ingestion waits for the monthly cost cap: the start of the next month (UTC), when it is ingested unless the cap is raised or lifted first; null otherwise", "title": "Parked Until" }, "source_id": { "description": "The source being read", "title": "Source Id", "type": "string" }, "status": { "description": "Ingestion status for this pair", "enum": [ "queued", "processing", "ready", "failed" ], "title": "Status", "type": "string" }, "title": { "description": "The source's own title", "title": "Title", "type": "string" }, "updated_at": { "description": "When this pair's ingestion state last changed", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "source_id", "title", "collection_id", "graph_id", "status", "fact_count", "epoch", "updated_at" ], "title": "SourceGraphStateRead", "type": "object" }, "SourceIndexStateRead": { "description": "One `(source, index)` pair's ingestion state, as `GET /knowledge/indexes/{id}/sources`\nreturns it.", "properties": { "chunk_count": { "description": "Chunks produced for this pair, once ready", "title": "Chunk Count", "type": "integer" }, "collection_id": { "description": "The collection the source belongs to", "title": "Collection Id", "type": "string" }, "epoch": { "description": "The index epoch this ingestion ran under", "title": "Epoch", "type": "integer" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Fixed failure code, when status is 'failed'", "title": "Error Code" }, "index_id": { "description": "The index it is being ingested into", "title": "Index Id", "type": "string" }, "object": { "const": "knowledge_source_index", "default": "knowledge_source_index", "description": "The object's type", "title": "Object", "type": "string" }, "parked_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Set on a 'queued' pair whose ingestion waits for the monthly cost cap: the start of the next month (UTC), when it is ingested unless the cap is raised or lifted first; null otherwise", "title": "Parked Until" }, "parse_fallback": { "anyOf": [ { "enum": [ "credits_exhausted", "api_key_rejected", "api_key_missing", "file_rejected" ], "type": "string" }, { "type": "null" } ], "description": "Set when the chunks this pair holds were read from the PDF's own text layer because the parsing service could not read it: 'credits_exhausted', 'api_key_rejected', 'api_key_missing' or 'file_rejected'. Reindexing the index once the service works again reads it through the service; 'file_rejected' stays refused. Null when the service read it, or no service was asked", "title": "Parse Fallback" }, "source_id": { "description": "The source being ingested", "title": "Source Id", "type": "string" }, "status": { "description": "Ingestion status for this pair", "enum": [ "queued", "processing", "ready", "failed" ], "title": "Status", "type": "string" }, "title": { "description": "The source's own title, so a listing names rows rather than ids", "title": "Title", "type": "string" }, "updated_at": { "description": "When this pair's ingestion state last changed", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "source_id", "title", "collection_id", "index_id", "status", "chunk_count", "epoch", "updated_at" ], "title": "SourceIndexStateRead", "type": "object" }, "SourceQueryRequest": { "additionalProperties": false, "description": "`POST .../sources/{id}/query`: a record query, plus which of the source's tables it\naddresses. A source with exactly one table accepts a body without `table_id`; one with\nseveral refuses a body that names none, since a question over \"the\" table of a workbook with\nthree of them is not one Core may answer by guessing.", "properties": { "aggregate": { "anyOf": [ { "$ref": "#/components/schemas/RecordAggregate" }, { "type": "null" } ], "description": "Aggregation" }, "filters": { "description": "Filter expressions", "items": { "$ref": "#/components/schemas/RecordFilter" }, "title": "Filters", "type": "array" }, "group_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Group by field", "title": "Group By" }, "limit": { "default": 50, "description": "Result limit; bounded here, not only at each caller, since a query can also be built by a model (`tabular_query`) rather than sent by a caller", "maximum": 500.0, "minimum": 1.0, "title": "Limit", "type": "integer" }, "table_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Which of the source's tables to query; may be left out when it has one", "title": "Table Id" } }, "title": "SourceQueryRequest", "type": "object" }, "SourceRead": { "description": "A knowledge source, as the API returns it. Never carries `raw`: the source's original\nbytes are not re-exposed once ingested. Carries no ingestion status: a source belongs to one\ncollection but may be ingested into several indexes, each at its own pace -- see\n`GET /knowledge/indexes/{id}/sources` for that per-index state.", "properties": { "bytes": { "default": 0, "description": "Size in bytes of the source's original content", "title": "Bytes", "type": "integer" }, "call_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tool call that produced this source, for an artifact", "title": "Call Id" }, "collection_id": { "description": "Collection this source belongs to", "title": "Collection Id", "type": "string" }, "created_at": { "description": "When this source was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created the source: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "deleted_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this source was deleted into the trash, where every read but the trash's own listing skips it; null while it is live", "title": "Deleted At" }, "id": { "description": "Knowledge source id", "title": "Id", "type": "string" }, "index_status": { "anyOf": [ { "enum": [ "queued", "processing", "ready", "failed" ], "type": "string" }, { "type": "null" } ], "description": "How far this source's own ingestion has got, over every index that draws it in: 'ready' when it can be searched, 'queued' or 'processing' while it is still being ingested, 'failed' when it could not be; null when no index holds it", "title": "Index Status" }, "kind": { "description": "How this source was supplied; 'connector' is one the collection's own connector discovered and synced, and 'artifact' is bytes a tool produced during a turn (docs/architecture/knowledge-and-memory.md)", "enum": [ "text", "file", "records", "connector", "artifact" ], "title": "Kind", "type": "string" }, "labels": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "the labels the rules over this row's kind read, as label -> a value or a list of values, read back exactly as written", "title": "Labels", "type": "object" }, "media_type": { "description": "MIME type of the source's original bytes", "title": "Media Type", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Caller-supplied metadata", "title": "Metadata", "type": "object" }, "object": { "const": "knowledge_source", "default": "knowledge_source", "description": "The object's type", "title": "Object", "type": "string" }, "parked_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Set while this source's ingestion is held at the monthly cost cap: it stays 'queued' until this instant, the start of the next month (UTC), or until the cap is raised or lifted, whichever comes first; null when nothing holds it", "title": "Parked Until" }, "purge_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the trash purges this source with its bytes, unless it is restored first; null while it is live", "title": "Purge At" }, "response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Response whose turn produced this source, for an artifact", "title": "Response Id" }, "retention": { "description": "whether the organisation's retention window covers this source", "enum": [ "window", "keep" ], "title": "Retention", "type": "string" }, "sha256": { "default": "", "description": "SHA-256 hex digest of the source's original content", "title": "Sha256", "type": "string" }, "shape": { "description": "Which built-in pipeline an index with no configured one ingests this source through: 'unstructured' chunks and embeds it, 'structured' extracts its tables", "enum": [ "unstructured", "structured" ], "title": "Shape", "type": "string" }, "table_count": { "default": 0, "description": "Tables extracted from this source so far; each carries its own schema and rows, read through `GET .../sources/{id}/tables`", "title": "Table Count", "type": "integer" }, "title": { "description": "Human-readable source title", "title": "Title", "type": "string" }, "tool_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the tool that produced this source, for an artifact", "title": "Tool Name" }, "updated_at": { "description": "When this source was last updated", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "collection_id", "kind", "shape", "title", "media_type", "metadata", "labels", "retention", "created_by", "created_at", "updated_at" ], "title": "SourceRead", "type": "object" }, "SourceTarget": { "description": "A session that ends as a knowledge source on a collection, as\n`POST /knowledge/collections/{id}/sources/upload` stores one.", "properties": { "collection_id": { "description": "The collection the source lands in", "title": "Collection Id", "type": "string" }, "kind": { "const": "source", "description": "The session ends as a knowledge source", "title": "Kind", "type": "string" }, "labels": { "default": {}, "description": "labels the rules over this row's kind read, as label -> a value or a list of 1 to 32 distinct values, each of 1 to 256 characters; at most 32 names. Held to the organisation's vocabulary and, for a request naming a person, to `writable_labels`", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "default": {}, "description": "The source's metadata, as a collection's upload takes it; `folder` puts it in a folder", "title": "Metadata", "type": "object" }, "retention": { "anyOf": [ { "enum": [ "window", "keep" ], "type": "string" }, { "type": "null" } ], "description": "'keep' keeps the source past the organisation's retention window; the collection's default when absent", "title": "Retention" }, "title": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "The source's title; the filename when absent", "title": "Title" } }, "required": [ "kind", "collection_id" ], "title": "SourceTarget", "type": "object" }, "SourceUpdate": { "additionalProperties": false, "description": "Body of `PATCH /knowledge/collections/{id}/sources/{sid}`; absent fields are left alone.\n\n`metadata` replaces the whole map -- the shape `PATCH /knowledge/collections/{id}` already\nuses -- and is a routing event: which indexes draw this source in is re-evaluated against\nevery link's own filter. A source's kind, shape and bytes are fixed for its whole life, and\nso is its collection while it is governed as knowledge; a file or an artifact moves between\nthe collections that hold files through `PATCH /files/{id}` or `PATCH /artifacts/{id}`, so\nnone of them is here.", "properties": { "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "labels the rules over this row's kind read, as label -> a value or a list of 1 to 32 distinct values, each of 1 to 256 characters; at most 32 names. Held to the organisation's vocabulary and, for a request naming a person, to `writable_labels`; replaces the source's whole labels map, which routes nothing", "title": "Labels" }, "metadata": { "anyOf": [ { "additionalProperties": { "maxLength": 2048, "type": "string" }, "description": "at most 64 pairs, each key at most 128 and each value at most 2048 characters", "maxProperties": 64, "propertyNames": { "maxLength": 128 }, "type": "object" }, { "type": "null" } ], "description": "Replaces the source's whole metadata map; re-routes it between indexes", "title": "Metadata" }, "retention": { "anyOf": [ { "enum": [ "window", "keep" ], "type": "string" }, { "type": "null" } ], "description": "whether the organisation's retention window covers this source: 'window' lets the pass take it once it is older than the window, 'keep' keeps it", "title": "Retention" }, "title": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Human-readable source title", "title": "Title" } }, "title": "SourceUpdate", "type": "object" }, "SpeechCreate": { "description": "What OpenAI's `audio/speech` takes, as far as Core has it. Every other field, OpenAI's\n`instructions` among them, is ignored, and so is a custom voice object.", "properties": { "input": { "description": "the text to speak, 1 to speech_input_max_chars characters (4,096 by default)", "title": "Input", "type": "string" }, "model": { "anyOf": [ { "maxLength": 200, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "catalogue id of a speech model; left out, Core picks one the key's policy admits (the operator's speech_default_model, else the first in region eu, else the first)", "title": "Model" }, "response_format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "mp3, wav, pcm, opus or flac, one the model declares; left out, the first", "title": "Response Format" }, "speed": { "anyOf": [ { "maximum": 4.0, "minimum": 0.25, "type": "number" }, { "type": "null" } ], "description": "0.25 to 4.0, for a model that takes a speed", "title": "Speed" }, "stream": { "default": false, "description": "true relays the vendor's audio as it arrives; false answers it whole", "title": "Stream", "type": "boolean" }, "voice": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "one of the model's declared voices; left out, the first. A custom voice object is ignored", "title": "Voice" } }, "required": [ "input" ], "title": "SpeechCreate", "type": "object" }, "SqlConnectorCreate": { "additionalProperties": false, "description": "Body of `POST /sql_connectors`.", "properties": { "auth": { "$ref": "#/components/schemas/BasicAuth", "description": "the database user and password Core logs in with. Written once, sealed, and never read back" }, "background": { "anyOf": [ { "$ref": "#/components/schemas/ToolBackground" }, { "type": "null" } ], "description": "whether a turn may start this connector as a task, for how long, and whether its call may be sent again after an interruption; omitted means never" }, "ca_pem": { "anyOf": [ { "maxLength": 65536, "type": "string" }, { "type": "null" } ], "description": "The certificate authority the server's certificate is checked against, as PEM; omitted checks it against the authorities the deployment trusts", "title": "Ca Pem" }, "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this version reads: a JSON Schema object with one property per `{@name}` in `statement`, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; they are bound as parameters beside the install values and the arguments, never written into the statement, never offered to the model, and stand only where a value goes -- never as a schema, table or column name. Every `{@name}` must be declared and every declaration used, and a name may not also be an argument or an install value; omitted declares none" }, "database": { "description": "The database to connect to; for Oracle, the service name", "maxLength": 128, "minLength": 1, "title": "Database", "type": "string" }, "description": { "description": "What the tool does, shown to the model", "maxLength": 1024, "title": "Description", "type": "string" }, "dialect": { "description": "Which database the server speaks", "enum": [ "postgres", "mysql", "sqlserver", "oracle" ], "title": "Dialect", "type": "string" }, "host": { "description": "The database server's host name or address", "maxLength": 253, "minLength": 1, "title": "Host", "type": "string" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/SqlInstallValue" }, "description": "A typed value for every `{$name}` in `statement`, by name: `{type, value, allowed, description}`. A `string`, `number` or `enum` is bound as a parameter, never written into the statement; an `identifier` is a schema, table or column name, written in quoted by the dialect's own rule. Every token needs a value and every value must be used. Not a secret: the password belongs to `auth`", "maxProperties": 64, "title": "Install Values", "type": "object" }, "labels": { "default": {}, "description": "The organisation's classification of this connector, as label -> value; what the rules over `tool` read", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "max_rows": { "default": 100, "description": "The most rows one call returns", "maximum": 1000.0, "minimum": 1.0, "title": "Max Rows", "type": "integer" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the connector, at most 16 KiB serialised: stored, returned and never read by Core; omitted or null stores {}", "title": "Metadata" }, "mode": { "default": "read", "description": "`read` runs only a SELECT (or WITH, VALUES, TABLE in Postgres) in a read-only transaction that is always rolled back; `write` also runs INSERT, UPDATE, DELETE, MERGE, REPLACE or CALL and commits, at the organisation's own risk", "enum": [ "read", "write" ], "title": "Mode", "type": "string" }, "name": { "description": "Connector name, unique per tenant; the model sees `sql__`", "pattern": "^[a-z0-9_-]{1,48}$", "title": "Name", "type": "string" }, "parameters": { "additionalProperties": true, "description": "JSON Schema object for the tool's arguments; each property is a `{name}` the statement may bind, and one listed under `required` must be sent", "title": "Parameters", "type": "object" }, "port": { "anyOf": [ { "maximum": 65535.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "Its TCP port; omitted is the dialect's own", "title": "Port" }, "region": { "anyOf": [ { "pattern": "^(eu|us|in-cluster|global|[a-z]{2})$", "type": "string" }, { "type": "null" } ], "description": "where this connector's database is served, as you assert it, judged as an API connector's region is; omitted leaves the host to `policy.settings.host_regions`", "title": "Region" }, "statement": { "description": "The one statement this tool runs. `{argument}` and `{$install}` placeholders become bound parameters where a value goes; a placeholder inside a literal, a quoted name or a comment, a second statement, and any schema change or privilege statement are refused", "maxLength": 16384, "minLength": 1, "title": "Statement", "type": "string" }, "timeout": { "anyOf": [ { "exclusiveMinimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "Seconds one call may take; omitted is the deployment's tool timeout, and a larger value is cut to it", "title": "Timeout" }, "tls": { "default": "verify-full", "description": "`verify-full` checks the server's certificate and its name; `require` encrypts, and checks the certificate only against a `ca_pem` given with it; SQL Server always checks the certificate chain, so `require` there skips the name check only. There is no setting without TLS", "enum": [ "verify-full", "require" ], "title": "Tls", "type": "string" } }, "required": [ "name", "description", "dialect", "host", "database", "statement", "auth" ], "title": "SqlConnectorCreate", "type": "object" }, "SqlConnectorRead": { "description": "A SQL connector, as `POST`/`GET`/`PATCH` return it: the flat fields are its latest\nversion's.", "properties": { "auth": { "$ref": "#/components/schemas/SourceAuthRead", "description": "the database user Core logs in as" }, "background": { "anyOf": [ { "$ref": "#/components/schemas/ToolBackground" }, { "type": "null" } ], "description": "whether this version may be started as a task; null is never" }, "ca_pem": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The certificate authority the server is checked against; null for the deployment's own", "title": "Ca Pem" }, "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this version reads: a JSON Schema object with one property per `{@name}` in `statement`, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; they are bound as parameters beside the install values and the arguments, never written into the statement, never offered to the model, and stand only where a value goes -- never as a schema, table or column name. Every `{@name}` must be declared and every declaration used, and a name may not also be an argument or an install value; a sealed copy still answers them, so a caller knows what to send" }, "created_at": { "description": "When this connector was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created this connector", "title": "Created By", "type": "string" }, "database": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The database it connects to; null when sealed", "title": "Database" }, "description": { "description": "What the tool does, shown to the model", "title": "Description", "type": "string" }, "dialect": { "description": "Which database the server speaks: `postgres`, `mysql`, `sqlserver` or `oracle`", "title": "Dialect", "type": "string" }, "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "egress": { "description": "The database host, with whether the organisation's allowed hosts permit it and whether the deployment blocks it, as of this read", "items": { "$ref": "#/components/schemas/HostAccess" }, "title": "Egress", "type": "array" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The database server's host; null for a sealed copy", "title": "Host" }, "id": { "description": "SQL connector id", "title": "Id", "type": "string" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/SqlInstallValue" }, "description": "A typed value for every `{$name}` in `statement`, by name: `{type, value, allowed, description}`. A `string`, `number` or `enum` is bound as a parameter, never written into the statement; an `identifier` is a schema, table or column name, written in quoted by the dialect's own rule. Every token needs a value and every value must be used. Not a secret: the password belongs to `auth`; empty for a sealed copy", "title": "Install Values", "type": "object" }, "labels": { "default": {}, "description": "The organisation's classification", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "latest_version": { "description": "The highest published version, which keys read and turns run; 0 for a connector with only drafts", "title": "Latest Version", "type": "integer" }, "max_rows": { "description": "The most rows one call returns", "title": "Max Rows", "type": "integer" }, "metadata": { "additionalProperties": true, "default": {}, "description": "The opaque document attached to this connector", "title": "Metadata", "type": "object" }, "mode": { "description": "`read` or `write`", "title": "Mode", "type": "string" }, "name": { "description": "Connector name, unique per tenant; the model sees `sql__`", "title": "Name", "type": "string" }, "object": { "const": "sql_connector", "default": "sql_connector", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/OriginRead" }, { "type": "null" } ], "description": "where this connector came from when a subscription installed it" }, "parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "JSON Schema object for the tool's arguments; null for a sealed copy", "title": "Parameters" }, "port": { "description": "Its TCP port", "title": "Port", "type": "integer" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "where the database is served", "title": "Region" }, "statement": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The statement this tool runs; null for a sealed copy", "title": "Statement" }, "timeout": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Seconds one call may take; null is the default", "title": "Timeout" }, "tls": { "description": "`verify-full` or `require`", "title": "Tls", "type": "string" }, "updated_at": { "description": "When this connector was last updated", "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "description": "the version the flat fields are: the latest published one, or, for a connector with only drafts, which only the management twin reads, its newest draft", "title": "Version", "type": "integer" } }, "required": [ "description", "parameters", "dialect", "host", "port", "database", "tls", "ca_pem", "statement", "mode", "max_rows", "timeout", "id", "name", "auth", "version", "latest_version", "created_by", "created_at", "updated_at" ], "title": "SqlConnectorRead", "type": "object" }, "SqlConnectorTestRead": { "description": "The answer of `POST /sql_connectors/{id}/test`: whether Core logged in and ran\n`SELECT 1`. A failure is a 200 with `ok: false` and a fixed code.", "properties": { "code": { "anyOf": [ { "enum": [ "egress_denied", "unreachable", "auth_failed", "timeout", "refused" ], "type": "string" }, { "type": "null" } ], "description": "Why not, as a fixed code: the host or its address refused by policy, the server not reached, the login refused, out of time, or the query refused; never the server's own message", "title": "Code" }, "object": { "const": "sql_connector_test", "default": "sql_connector_test", "description": "The object's type", "title": "Object", "type": "string" }, "ok": { "description": "Whether Core reached the database, logged in and ran SELECT 1", "title": "Ok", "type": "boolean" } }, "required": [ "ok" ], "title": "SqlConnectorTestRead", "type": "object" }, "SqlConnectorUpdate": { "additionalProperties": false, "description": "Body of `PATCH /sql_connectors/{connector_id}`; every field is optional and left alone when\nabsent. `name` never changes after creation.", "properties": { "auth": { "anyOf": [ { "$ref": "#/components/schemas/BasicAuth" }, { "type": "null" } ], "description": "new user and password, replacing the stored ones; omitted leaves them" }, "background": { "anyOf": [ { "$ref": "#/components/schemas/ToolBackground" }, { "type": "null" } ], "description": "new background setting; an explicit null clears it back to never" }, "ca_pem": { "anyOf": [ { "maxLength": 65536, "type": "string" }, { "type": "null" } ], "description": "new certificate authority; an explicit null goes back to the authorities the deployment trusts, and an omitted field leaves it alone", "title": "Ca Pem" }, "call_variables": { "anyOf": [ { "$ref": "#/components/schemas/CallVariables" }, { "type": "null" } ], "description": "new call variables, replacing the whole declaration and making a new version; omitted leaves them alone. The call variables this version reads: a JSON Schema object with one property per `{@name}` in `statement`, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; they are bound as parameters beside the install values and the arguments, never written into the statement, never offered to the model, and stand only where a value goes -- never as a schema, table or column name. Every `{@name}` must be declared and every declaration used, and a name may not also be an argument or an install value" }, "database": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The database to connect to; for Oracle, the service name", "title": "Database" }, "description": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "What the tool does, shown to the model", "title": "Description" }, "dialect": { "anyOf": [ { "enum": [ "postgres", "mysql", "sqlserver", "oracle" ], "type": "string" }, { "type": "null" } ], "description": "Which database the server speaks", "title": "Dialect" }, "host": { "anyOf": [ { "maxLength": 253, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The database server's host name", "title": "Host" }, "install_values": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/SqlInstallValue" }, "maxProperties": 64, "type": "object" }, { "type": "null" } ], "description": "new install values, replacing every stored one; omitted leaves them alone, and {} clears them. A typed value for every `{$name}` in `statement`, by name: `{type, value, allowed, description}`. A `string`, `number` or `enum` is bound as a parameter, never written into the statement; an `identifier` is a schema, table or column name, written in quoted by the dialect's own rule. Every token needs a value and every value must be used. Not a secret: the password belongs to `auth`", "title": "Install Values" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "new classification, replacing whatever is stored", "title": "Labels" }, "max_rows": { "anyOf": [ { "maximum": 1000.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "The most rows one call returns", "title": "Max Rows" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "new opaque document, replacing whatever is stored whole", "title": "Metadata" }, "mode": { "anyOf": [ { "enum": [ "read", "write" ], "type": "string" }, { "type": "null" } ], "description": "`read` or `write`", "title": "Mode" }, "parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "JSON Schema object for the tool's arguments", "title": "Parameters" }, "port": { "anyOf": [ { "maximum": 65535.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "Its TCP port", "title": "Port" }, "region": { "anyOf": [ { "pattern": "^(eu|us|in-cluster|global|[a-z]{2})$", "type": "string" }, { "type": "null" } ], "description": "new region; an explicit null clears it, an omitted field leaves it alone", "title": "Region" }, "statement": { "anyOf": [ { "maxLength": 16384, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The one statement", "title": "Statement" }, "timeout": { "anyOf": [ { "exclusiveMinimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "Seconds one call may take; an explicit null is the deployment's own", "title": "Timeout" }, "tls": { "anyOf": [ { "enum": [ "verify-full", "require" ], "type": "string" }, { "type": "null" } ], "description": "`verify-full` or `require`", "title": "Tls" } }, "title": "SqlConnectorUpdate", "type": "object" }, "SqlConnectorVersionRead": { "description": "One immutable version of a SQL connector.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "background": { "anyOf": [ { "$ref": "#/components/schemas/ToolBackground" }, { "type": "null" } ], "description": "whether this version may be started as a task; null is never" }, "ca_pem": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The certificate authority the server is checked against; null for the deployment's own", "title": "Ca Pem" }, "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this version reads: a JSON Schema object with one property per `{@name}` in `statement`, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; they are bound as parameters beside the install values and the arguments, never written into the statement, never offered to the model, and stand only where a value goes -- never as a schema, table or column name. Every `{@name}` must be declared and every declaration used, and a name may not also be an argument or an install value; a sealed copy still answers them, so a caller knows what to send" }, "connector_id": { "description": "Connector this version belongs to", "title": "Connector Id", "type": "string" }, "created_at": { "description": "When this version was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created this version", "title": "Created By", "type": "string" }, "database": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The database it connects to; null when sealed", "title": "Database" }, "description": { "description": "What the tool does, shown to the model", "title": "Description", "type": "string" }, "dialect": { "description": "Which database the server speaks: `postgres`, `mysql`, `sqlserver` or `oracle`", "title": "Dialect", "type": "string" }, "host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The database server's host; null for a sealed copy", "title": "Host" }, "id": { "description": "SQL connector version id", "title": "Id", "type": "string" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/SqlInstallValue" }, "description": "A typed value for every `{$name}` in `statement`, by name: `{type, value, allowed, description}`. A `string`, `number` or `enum` is bound as a parameter, never written into the statement; an `identifier` is a schema, table or column name, written in quoted by the dialect's own rule. Every token needs a value and every value must be used. Not a secret: the password belongs to `auth`; empty for a sealed copy", "title": "Install Values", "type": "object" }, "max_rows": { "description": "The most rows one call returns", "title": "Max Rows", "type": "integer" }, "mode": { "description": "`read` or `write`", "title": "Mode", "type": "string" }, "object": { "const": "sql_connector_version", "default": "sql_connector_version", "description": "The object's type", "title": "Object", "type": "string" }, "parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "JSON Schema object for the tool's arguments; null for a sealed copy", "title": "Parameters" }, "port": { "description": "Its TCP port", "title": "Port", "type": "integer" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "sealed": { "default": false, "description": "Whether this version was installed under sealed terms, so its statement, host, database and argument schema are withheld here for good", "title": "Sealed", "type": "boolean" }, "state": { "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "statement": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The statement this tool runs; null for a sealed copy", "title": "Statement" }, "timeout": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Seconds one call may take; null is the default", "title": "Timeout" }, "tls": { "description": "`verify-full` or `require`", "title": "Tls", "type": "string" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" } }, "required": [ "description", "parameters", "dialect", "host", "port", "database", "tls", "ca_pem", "statement", "mode", "max_rows", "timeout", "id", "connector_id", "version", "state", "created_by", "acted_for", "created_at" ], "title": "SqlConnectorVersionRead", "type": "object" }, "SqlInstallValue": { "additionalProperties": false, "description": "One `{$name}`'s value and what it is: an install value as an API connector's, or the name\nof a schema, a table or a column.", "properties": { "allowed": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 64, "minItems": 1, "type": "array" }, { "type": "null" } ], "description": "the values an enum admits, `value` among them; required for enum and refused elsewhere", "title": "Allowed" }, "description": { "default": "", "description": "what this value is for, shown to whoever sets it", "maxLength": 1024, "title": "Description", "type": "string" }, "type": { "description": "string, number, enum or identifier", "enum": [ "string", "number", "enum", "identifier" ], "title": "Type", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ], "description": "the value: a finite number for `number`, text for the others; an `identifier` is a name of at most 63 characters, written into the statement quoted", "title": "Value" } }, "required": [ "type", "value" ], "title": "SqlInstallValue", "type": "object" }, "Step": { "additionalProperties": false, "description": "One turn of a scenario: the user message that is sent, and what its answer is held to.", "properties": { "checks": { "description": "the rules this step's answer is held to; a step with none passes when its turn succeeded", "items": { "$ref": "#/components/schemas/Check" }, "maxItems": 16, "title": "Checks", "type": "array" }, "id": { "anyOf": [ { "maxLength": 64, "pattern": "^evt_[A-Za-z0-9]+$", "type": "string" }, { "type": "null" } ], "description": "stable `evt_` id; assigned by the server when absent, and kept when present so a result recorded against this step stays linkable after the scenario is edited. A caller may only send an id the server itself could have minted", "title": "Id" }, "input": { "description": "the user message this step sends", "maxLength": 8192, "minLength": 1, "title": "Input", "type": "string" } }, "required": [ "input" ], "title": "Step", "type": "object" }, "StepResult": { "additionalProperties": false, "description": "What one step of a run did: the turn it ran, how long it took, and what its checks said.", "properties": { "checks": { "description": "one result per check, in the author's order", "items": { "$ref": "#/components/schemas/CheckResult" }, "title": "Checks", "type": "array" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "why this step has no answer, when the turn failed or was skipped", "title": "Error" }, "latency_ms": { "default": 0, "description": "how long the turn took, in milliseconds", "title": "Latency Ms", "type": "integer" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the model that answered this step's turn, when one ran", "title": "Model" }, "output": { "default": "", "description": "the agent's final text for this step", "title": "Output", "type": "string" }, "passed": { "description": "whether every required check passed", "title": "Passed", "type": "boolean" }, "response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the response this step's turn produced, when one ran; when the agent names a router, `GET /responses/{id}/routing` is the record of where it went", "title": "Response Id" }, "router": { "anyOf": [ { "$ref": "#/components/schemas/RunRouter" }, { "type": "null" } ], "description": "the router and version that routed this step's turn, when the agent names one and the turn was routed" }, "step_id": { "description": "the snapshot step this result belongs to", "title": "Step Id", "type": "string" } }, "required": [ "step_id", "passed" ], "title": "StepResult", "type": "object" }, "SubjectClaims": { "additionalProperties": false, "description": "Which claim of a verified token is the person, and which claims are their attributes.\n\nThe organisation writes this, because only the organisation knows what its identity provider\nputs where. Core maps and never interprets: a claim it cannot read as a string or a list of\nstrings is a refusal rather than a value coerced into one, for the reason a `metadata` value\nthat is not a string fails a condition -- one rule must not decide two ways depending on how\nthe token was written.", "properties": { "attributes": { "default": {}, "description": "attribute name -> the claim its values are read from; a claim absent from a token is an attribute the request does not assert, never an error", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "maxLength": 256, "minLength": 1, "type": "string" } }, "title": "Attributes", "type": "object" }, "id": { "default": "sub", "description": "the claim holding the person's own identifier, which must match the `user` grammar Core holds every subject id to; `sub` unless the organisation maps something else", "maxLength": 256, "minLength": 1, "title": "Id", "type": "string" } }, "title": "SubjectClaims", "type": "object" }, "SubjectErasureQueued": { "description": "`202` from `DELETE /subjects/{id}`: the erasure is the worker's, and this is its receipt.\n\nAsking twice while one is still queued answers the same id: the erasure is keyed by the\nperson, not by the request (`app.subjects.erase`).", "properties": { "erasure_id": { "description": "this erasure's own id, repeated in the `subject.erased` audit row the worker writes when it finishes", "title": "Erasure Id", "type": "string" }, "status": { "description": "always `queued`: nothing is deleted inside the request", "title": "Status", "type": "string" } }, "required": [ "erasure_id", "status" ], "title": "SubjectErasureQueued", "type": "object" }, "SubjectHoldings": { "description": "`GET /subjects/{id}`: what Core holds for one person on this organisation, and nothing\nelse. There is nothing else -- Core keeps no name, no profile and no account\n(`docs/architecture/subjects.md` \"What Core never holds\").", "properties": { "audio_transcription_jobs": { "default": 0, "description": "transcription jobs made for this person, with their transcripts (`docs/architecture/audio-transcription.md`)", "title": "Audio Transcription Jobs", "type": "integer" }, "authored_items": { "default": 0, "description": "items this person wrote in threads that are not hers, in a thread several people write in (`docs/architecture/threads.md#several-people-in-one-thread`)", "title": "Authored Items", "type": "integer" }, "datastore_records": { "default": 0, "description": "datastore records written for this person (`docs/architecture/datastores.md`)", "title": "Datastore Records", "type": "integer" }, "datastore_records_retained": { "default": 0, "description": "datastore records written for this person that a datastore retained for bookkeeping keeps through an erasure, still naming them, until its own expiry", "title": "Datastore Records Retained", "type": "integer" }, "evaluation_runs": { "default": 0, "description": "evaluation runs that act, or acted, for this person; erasing them keeps each run, cancelled if still open, emptied of her turns and no longer naming her (`docs/architecture/evaluations.md#a-run-for-a-person`)", "title": "Evaluation Runs", "type": "integer" }, "grants": { "description": "authorizations this person made at a registered source, by their own id", "title": "Grants", "type": "integer" }, "id": { "description": "the person these counts are for, as the caller named them", "title": "Id", "type": "string" }, "item_metadata": { "default": 0, "description": "documents this person wrote on thread items, such as a thumbs up (`docs/architecture/threads.md#item-metadata`)", "title": "Item Metadata", "type": "integer" }, "memory_records": { "description": "memory records written for this person", "title": "Memory Records", "type": "integer" }, "model_calls": { "default": 0, "description": "traced model calls made for this person -- one per call, each with the request the provider received behind it (`docs/architecture/tracing.md`)", "title": "Model Calls", "type": "integer" }, "responses": { "description": "stored turns written for this person", "title": "Responses", "type": "integer" }, "schedules": { "default": 0, "description": "schedules that fire turns for this person; erasing them switches these off rather than firing for nobody (`docs/architecture/schedules.md`)", "title": "Schedules", "type": "integer" }, "sources": { "description": "knowledge sources -- uploads and the artifacts a turn produced -- written for this person", "title": "Sources", "type": "integer" }, "tasks": { "default": 0, "description": "background tasks started for this person (`docs/architecture/tasks.md`)", "title": "Tasks", "type": "integer" }, "threads": { "description": "threads written for this person", "title": "Threads", "type": "integer" }, "upload_sessions": { "default": 0, "description": "upload sessions opened for this person and not yet deleted (`docs/architecture/files-and-artifacts.md#upload-sessions`)", "title": "Upload Sessions", "type": "integer" }, "workflow_runs": { "default": 0, "description": "workflow runs started for this person (`docs/architecture/workflows.md`)", "title": "Workflow Runs", "type": "integer" } }, "required": [ "id", "threads", "responses", "memory_records", "sources", "grants" ], "title": "SubjectHoldings", "type": "object" }, "SubjectIssuer": { "additionalProperties": false, "description": "One identity provider this organisation vouches for, and how a token of its becomes a\nsubject.\n\n`issuer` and `audience` are matched exactly, never by prefix: an assertion minted for another\naudience at the same provider is a token this organisation did not ask for, and accepting it\nwould make every application sharing that provider a way into this tenant's data.", "properties": { "algorithms": { "default": [ "RS256" ], "description": "which signature algorithms a token of this issuer may use; pinned here rather than read from the token's own header", "items": { "enum": [ "RS256", "ES256" ], "type": "string" }, "maxItems": 2, "minItems": 1, "title": "Algorithms", "type": "array" }, "audience": { "description": "the exact `aud` this organisation's own tokens are minted for; required, because a token minted for somebody else at the same provider is not this organisation's to accept", "maxLength": 512, "minLength": 1, "title": "Audience", "type": "string" }, "claims": { "$ref": "#/components/schemas/SubjectClaims", "description": "which claim of a verified token is the person, and which are the attributes their reach is decided from" }, "issuer": { "description": "the exact `iss` claim a token of this provider carries; matched whole, never by prefix", "maxLength": 512, "minLength": 1, "title": "Issuer", "type": "string" }, "jwks": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the provider's JWKS document, inline -- public keys only, and the option that reaches no network at all", "title": "Jwks" }, "jwks_uri": { "anyOf": [ { "format": "uri", "maxLength": 2083, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "https address of the provider's JWKS document instead; its host must be one of the organisation's allowed hosts and is dialled through the deployment's proxy", "title": "Jwks Uri" } }, "required": [ "issuer", "audience" ], "title": "SubjectIssuer", "type": "object" }, "SubjectIssuersRead": { "description": "What both twins answer: the list as it now stands.\n\nIt echoes the JWKS a registration sent, and that is safe by construction -- a JWKS is a\ndocument of public keys, which the model refuses to store any private half of\n(`app.subjects.issuers`). Nothing else about a verified token is ever readable here: Core\nstores no token, no claim and no digest of either.", "properties": { "egress": { "description": "every host a `jwks_uri` of these issuers names, each with whether the organisation's allowed hosts permit it and whether the deployment blocks it, as of this read. An issuer whose host is not allowed, or is blocked, verifies no assertion", "items": { "$ref": "#/components/schemas/HostAccess" }, "title": "Egress", "type": "array" }, "issuers": { "description": "every identity provider this organisation vouches for, in the order it registered them", "items": { "$ref": "#/components/schemas/SubjectIssuer" }, "title": "Issuers", "type": "array" } }, "required": [ "issuers" ], "title": "SubjectIssuersRead", "type": "object" }, "SubjectIssuersUpdate": { "additionalProperties": false, "description": "`PUT /tenants/{id}/subject-issuers` and its key-facing twin: the whole list, replaced.\n\nWhole rather than one at a time, for the reason `permitted_capabilities` is one field: the\nlist is short, it is read as a unit on every request that presents an assertion, and an\norganisation editing who it believes should see what it will have when the call returns.\n`[]` removes every registration, after which its keys may present no assertion at all.", "properties": { "issuers": { "description": "every identity provider this organisation vouches for, replacing whatever it had registered; at most 8, each naming an `issuer` no other names", "items": { "$ref": "#/components/schemas/SubjectIssuer" }, "maxItems": 8, "title": "Issuers", "type": "array" } }, "title": "SubjectIssuersUpdate", "type": "object" }, "SubjectKindUsage": { "description": "What one subject used of one usage kind over the window (`SubjectUsage.by_kind`).", "properties": { "cost_eur": { "description": "What this kind's rows cost, in euro as an exact decimal, at the price in force for each row when it was recorded", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Cost Eur", "type": "string" }, "input_tokens": { "description": "Sum of input tokens across this kind's rows", "title": "Input Tokens", "type": "integer" }, "kind": { "description": "The usage kind these rows were metered as", "title": "Kind", "type": "string" }, "output_tokens": { "description": "Sum of output tokens across this kind's rows", "title": "Output Tokens", "type": "integer" }, "quantity": { "description": "Sum of the counted units across this kind's rows: images, invocations, pages, seconds or uses, by kind; 0 for a kind counted in tokens", "title": "Quantity", "type": "integer" }, "unpriced": { "description": "How many of this kind's rows no price covered", "title": "Unpriced", "type": "integer" } }, "required": [ "kind", "input_tokens", "output_tokens", "quantity", "cost_eur", "unpriced" ], "title": "SubjectKindUsage", "type": "object" }, "SubjectSpec": { "additionalProperties": false, "description": "The wire shape of a subject: `{\"id\": \"...\", \"attributes\": {\"department\": [\"payroll\"]}}`.\n\nA bare string is accepted where a list belongs (`{\"department\": \"payroll\"}`), because that is\nwhat an application with one value per attribute will send and refusing it would buy nothing.\n`extra=\"forbid\"`: an attribute misspelled as a sibling of `id` is a rule that silently stops\nmatching, which is the failure this shape exists to prevent.", "properties": { "attributes": { "default": {}, "description": "what this request asserts about that person, as name -> value or name -> list of values; at most 32 names, at most 32 values each, and never stored by Core", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "type": "array" } ] } }, "title": "Attributes", "type": "object" }, "id": { "description": "the calling application's own opaque identifier of the person this request is for -- never a name, an address or anything else about them", "pattern": "^[A-Za-z0-9._:@-]{1,128}$", "title": "Id", "type": "string" } }, "required": [ "id" ], "title": "SubjectSpec", "type": "object" }, "SubjectTokenCreate": { "additionalProperties": false, "description": "`POST /subjects/tokens`: the person to bind a token to, and how long it may live.\n\nExactly one of two ways to say who. `subject` is the backend asserting it itself, which is\nwhat a partner whose own application knows its people sends. `assertion` is the backend\nhanding Core the token its identity provider already minted, so the person and the attributes\nare the provider's word rather than the backend's -- the same verification an assertion in\n`X-Core-Subject` gets, against the same registered issuers\n(`docs/architecture/subjects.md` \"A subject token\").", "properties": { "assertion": { "anyOf": [ { "maxLength": 8192, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "a token one of this organisation's registered subject issuers signed, in place of `subject`: the person and the attributes are read from its verified claims, and the token itself is stored nowhere", "title": "Assertion" }, "expires_in": { "default": 900, "description": "seconds this token stays valid, at most an hour; it cannot be withdrawn earlier than that except by rotating the key that minted it", "maximum": 3600.0, "minimum": 1.0, "title": "Expires In", "type": "integer" }, "subject": { "anyOf": [ { "$ref": "#/components/schemas/SubjectSpec" }, { "type": "null" } ], "description": "the person every request made with this token is for, with the attributes the token freezes for its whole life -- Core stores neither" } }, "title": "SubjectTokenCreate", "type": "object" }, "SubjectTokenIssued": { "description": "`201` from `POST /subjects/tokens`: the only copy of the token there will ever be.\n\nCore writes no row for it, so this body is not readable again from anywhere -- which is the\nsame contract a key's own secret has (`docs/architecture/identity.md`).", "properties": { "expires_at": { "description": "when this token stops being accepted, to the second; there is no way to end it sooner short of rotating the key", "format": "date-time", "title": "Expires At", "type": "string" }, "subject_id": { "description": "the person this token is bound to, echoed so a caller can match it to the request it made; the attributes are deliberately not echoed", "title": "Subject Id", "type": "string" }, "token": { "description": "the bearer token, `ast_` and the sealed payload; hand it to the person's own device and never store it", "title": "Token", "type": "string" } }, "required": [ "token", "subject_id", "expires_at" ], "title": "SubjectTokenIssued", "type": "object" }, "SubjectUsage": { "description": "Usage summed for one subject, or for the rows a `GET /usage/by-subject` read found no\nsubject on at all (`UsageBySubject.unattributed`).", "properties": { "by_kind": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SubjectKindUsage" }, "type": "array" }, { "type": "null" } ], "description": "This total split by usage kind, one entry per kind it had rows of, ordered by kind, adding up to its tokens and cost_eur; null unless the read asked for by_kind=true", "title": "By Kind" }, "cost_eur": { "description": "What this total cost, in euro as an exact decimal, at the price in force for each of its rows when that row was recorded -- so a price change inside the window splits the cost rather than re-pricing what came before it", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Cost Eur", "type": "string" }, "first_seen_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Earliest created_at among this total's rows; null when it sums none -- an unattributed total on a window with no unattributed rows in it", "title": "First Seen At" }, "input_tokens": { "description": "Sum of input tokens across this total's rows", "title": "Input Tokens", "type": "integer" }, "last_seen_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Latest created_at among this total's rows; null on the same terms as first_seen_at", "title": "Last Seen At" }, "messages_appended": { "description": "How many message items -- ItemRecord.type == 'message', never a tool call, its result, a reasoning block or a refusal -- were appended to one of this subject's threads in the window, on the same narrowing as threads_created; on unattributed, messages on a thread nobody was named on", "title": "Messages Appended", "type": "integer" }, "output_tokens": { "description": "Sum of output tokens across this total's rows", "title": "Output Tokens", "type": "integer" }, "reasoning_tokens": { "description": "How many of this total's output tokens were spent thinking, summed over the rows whose provider reported it -- a total no provider reported any for sums to 0, not to null. Already inside output_tokens", "title": "Reasoning Tokens", "type": "integer" }, "rows": { "description": "How many usage rows this total sums", "title": "Rows", "type": "integer" }, "subject_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person these rows were metered for, by the id the calling application named them with; null on `unattributed`, for rows a request or turn named nobody on", "title": "Subject Id" }, "threads_created": { "description": "How many threads this subject created in the window, by Thread.subject_id -- narrowed to key_id the same way this total's usage rows are. On unattributed, threads a request or a turn named nobody on (Thread.subject_id is null), the same rows unattributed's cost_eur sums", "title": "Threads Created", "type": "integer" }, "unpriced": { "description": "How many of this total's rows no price covered. Those rows cost zero, so a total with unpriced above zero is a floor on what was actually spent", "title": "Unpriced", "type": "integer" } }, "required": [ "subject_id", "rows", "input_tokens", "output_tokens", "reasoning_tokens", "cost_eur", "unpriced", "threads_created", "messages_appended", "first_seen_at", "last_seen_at" ], "title": "SubjectUsage", "type": "object" }, "SubjectsConfig": { "additionalProperties": false, "description": "The `subjects` capability: minting a subject token, and asking what Core holds for one\nperson or erasing it (`docs/architecture/subjects.md`).\n\nNo configuration and no dependency. Nothing about a credential that lives for at most an hour\nis a knob, and the three routes it gates stand on no other capability: whether a subject's\nthreads, memory or files exist at all is each of those capabilities' own question, and a key\nthat holds none of them still has a person to erase -- the audit and usage rows keep that\nperson's id whatever else the key ever switched on.\n\nNaming a subject *on a turn* needs no capability at all, exactly as `user` needed none: a\nperson narrows what a key reaches and is never something a key has to be granted first. This\none gates the three routes that mint credentials and delete rows, which is a different\nquestion and the reason it is not simply on for everybody.", "properties": {}, "title": "SubjectsConfig", "type": "object" }, "SubmitToolOutputsRequest": { "additionalProperties": false, "description": "Body of `POST /responses/{response_id}/tool_outputs`.", "properties": { "outputs": { "description": "results for the run's pending client tool calls", "items": { "$ref": "#/components/schemas/ToolOutputSubmission" }, "maxItems": 64, "minItems": 1, "title": "Outputs", "type": "array" } }, "required": [ "outputs" ], "title": "SubmitToolOutputsRequest", "type": "object" }, "SubscriptionCreate": { "additionalProperties": false, "description": "Body of `POST /tenants/{tenant_id}/subscriptions`: install one publication here.", "properties": { "config": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ] }, "description": "Values for the manifest's parameters, by parameter name; never a secret", "title": "Config", "type": "object" }, "follow": { "default": "latest", "description": "'latest' to take every new version as it is published, 'pinned' to stay on one", "enum": [ "latest", "pinned" ], "title": "Follow", "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the subscription, at most 16 KiB serialised: stored, returned and never read by Core; omitted or null stores {}", "title": "Metadata" }, "pinned_version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "The version to stay on, for 'pinned'", "title": "Pinned Version" }, "prefix": { "anyOf": [ { "pattern": "^[a-z0-9]{1,16}-$", "type": "string" }, { "type": "null" } ], "description": "Prepended to every member's name, so a rule can name them by pattern (`acme-*`)", "title": "Prefix" }, "publication_id": { "description": "The publication to install", "maxLength": 64, "title": "Publication Id", "type": "string" }, "secrets": { "additionalProperties": { "additionalProperties": true, "type": "object" }, "description": "Credentials for the manifest's `credential` parameters, by parameter name, each in the shape an API connector's own `auth` takes. Write-only: sealed under this subscription's id and returned by nothing", "title": "Secrets", "type": "object" } }, "required": [ "publication_id" ], "title": "SubscriptionCreate", "type": "object" }, "SubscriptionRead": { "description": "A subscription, as the API returns it -- with the two names that say *which app, from\nwhom* and the app's cover, read in one statement for a whole page\n(`app.sharing.subscriptions.publication_names`).", "properties": { "accepted_terms_version": { "description": "The version whose terms this subscriber accepted", "title": "Accepted Terms Version", "type": "integer" }, "config": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ] }, "description": "Values supplied for the parameters", "title": "Config", "type": "object" }, "config_version": { "default": 0, "description": "How many times the parameter values have changed since the subscription was written; each change is written into the copies by the sync it queues", "title": "Config Version", "type": "integer" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/CoverRead" }, { "type": "null" } ], "description": "The publication's listing cover, or null when it has none; the image itself is read from `.../available-publications/{id}/cover`" }, "created_at": { "description": "When the subscription was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who created it: a key's id, or `operator:` for a human", "title": "Created By", "type": "string" }, "follow": { "description": "Whether it takes every new version or stays on one", "enum": [ "latest", "pinned" ], "title": "Follow", "type": "string" }, "id": { "description": "Subscription id", "title": "Id", "type": "string" }, "installed_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Version the copies reflect; null until the first sync lands", "title": "Installed Version" }, "last_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why the last sync failed, or why the subscription waits at needs_configuration (`unconfigured_client:`, written by the subscribe, a PATCH or the sync): a fixed code and the member or application, never a body", "title": "Last Error" }, "last_synced_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When a sync last finished", "title": "Last Synced At" }, "metadata": { "additionalProperties": true, "description": "The opaque document attached to this subscription; {} when none was set", "title": "Metadata", "type": "object" }, "object": { "const": "subscription", "default": "subscription", "description": "The object's type", "title": "Object", "type": "string" }, "pinned_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The version it stays on, for 'pinned'", "title": "Pinned Version" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Prepended to every member's name; null for none", "title": "Prefix" }, "publication_id": { "description": "The publication installed", "title": "Publication Id", "type": "string" }, "publication_name": { "default": "", "description": "That publication's name, as its publisher gave it", "title": "Publication Name", "type": "string" }, "publisher_name": { "default": "", "description": "The publishing organisation's name; empty when that organisation has been erased, which a publication deliberately outlives", "title": "Publisher Name", "type": "string" }, "secrets_version": { "default": 0, "description": "How many times the supplied credentials have been rewritten; 0 means none was ever supplied", "title": "Secrets Version", "type": "integer" }, "status": { "description": "Where the install stands", "enum": [ "installing", "linked", "diverged", "stale", "needs_configuration", "needs_acceptance", "releasing", "suspended" ], "title": "Status", "type": "string" }, "supplied_secrets": { "description": "The credential parameters a value has been supplied for, by name only -- the values themselves are sealed and are returned by nothing", "items": { "type": "string" }, "title": "Supplied Secrets", "type": "array" }, "suspend_reason": { "anyOf": [ { "enum": [ "entitlement", "cancelled" ], "type": "string" }, { "type": "null" } ], "description": "Why a 'suspended' subscription is: 'entitlement' when its entitlement lapsed and a renewal brings it back, 'cancelled' when it was un-subscribed or withdrawn and only the subscriber's own `POST .../sync` does; null in every other status", "title": "Suspend Reason" }, "tenant_id": { "description": "The subscribing organisation", "title": "Tenant Id", "type": "string" }, "updated_at": { "description": "When the subscription last changed", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "publication_id", "installed_version", "follow", "pinned_version", "prefix", "config", "accepted_terms_version", "status", "last_error", "last_synced_at", "created_by", "created_at", "updated_at", "metadata" ], "title": "SubscriptionRead", "type": "object" }, "SubscriptionSecrets": { "additionalProperties": false, "description": "Body of `PATCH /tenants/{tenant_id}/subscriptions/{id}/secrets`.\n\nIts own route and its own body, not a third field on `SubscriptionUpdate`, because credentials\nare the one thing about a subscription that is never read back, never merged into a read model\nand never logged: a caller changing a credential should not have to resend a `config` it is not\nchanging, and a caller changing a `config` should never carry a secret at all. The service\nfunction beside it (`apply_secrets`) is the third of the three `apply_*` the kernel's `PATCH`\nalready has, and the state it lands in is decided by the same `resettle_subscription`.", "properties": { "secrets": { "additionalProperties": { "additionalProperties": true, "type": "object" }, "description": "Credentials to seal, by parameter name; a name already supplied is replaced, one omitted is left exactly as it is, and an explicit empty object clears it", "title": "Secrets", "type": "object" } }, "title": "SubscriptionSecrets", "type": "object" }, "SubscriptionUpdate": { "additionalProperties": false, "description": "Body of `PATCH /tenants/{tenant_id}/subscriptions/{id}`: what a subscriber can still\ndecide about an install it already made.\n\nBoth fields are optional and independent, and each is applied by one service function of its\nown, so the field a later brief adds (a connector's `secrets`) is a third function rather than\na rewrite of this one.", "properties": { "accept_terms_version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "Accept the terms of this publication version, and the packages its scripts carry, which is what clears a subscription held at 'needs_acceptance'", "title": "Accept Terms Version" }, "config": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ] }, "type": "object" }, { "type": "null" } ], "description": "Replace the parameter values, re-validated against the version this subscription installs; once nothing required is missing the install starts", "title": "Config" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "new opaque document, replacing whatever is stored whole; omitted leaves it alone, and {} clears it", "title": "Metadata" } }, "title": "SubscriptionUpdate", "type": "object" }, "SummaryText": { "additionalProperties": false, "description": "One paragraph of a reasoning item's summary.", "properties": { "text": { "description": "one paragraph of the reasoning summary", "title": "Text", "type": "string" }, "type": { "const": "summary_text", "default": "summary_text", "description": "summary part kind", "title": "Type", "type": "string" } }, "required": [ "text" ], "title": "SummaryText", "type": "object" }, "SyncQueued": { "description": "Answer of `POST /tenants/{tenant_id}/subscriptions/{id}/sync`: there is no run of its own\nto report, only the one `subscription.sync` outbox row a `linked`, `diverged` or `stale`\nsubscription already gets from a config or a secrets change, asked for directly instead.", "properties": { "queued": { "description": "Always true; the route answers 409 rather than 200 with false", "title": "Queued", "type": "boolean" } }, "required": [ "queued" ], "title": "SyncQueued", "type": "object" }, "SyncRunRead": { "description": "One sync of one connector, as the API returns it.", "properties": { "added": { "description": "Sources created for newly discovered items", "title": "Added", "type": "integer" }, "connector_id": { "description": "Connector this run syncs", "title": "Connector Id", "type": "string" }, "created_at": { "description": "When this run was created", "format": "date-time", "title": "Created At", "type": "string" }, "discovered": { "description": "Items the provider offered, after filtering", "title": "Discovered", "type": "integer" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Fixed failure code, when failed", "title": "Error Code" }, "failed": { "description": "Items this run could not fetch or store", "title": "Failed", "type": "integer" }, "finished_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this run finished", "title": "Finished At" }, "id": { "description": "Sync run id", "title": "Id", "type": "string" }, "object": { "const": "knowledge_sync_run", "default": "knowledge_sync_run", "description": "The object's type", "title": "Object", "type": "string" }, "removed": { "description": "Sources deleted because the item is gone", "title": "Removed", "type": "integer" }, "skipped": { "description": "Items left alone: unchanged, or over the size cap", "title": "Skipped", "type": "integer" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this run began executing", "title": "Started At" }, "status": { "description": "This run's current status", "enum": [ "queued", "running", "completed", "failed", "cancelled" ], "title": "Status", "type": "string" }, "trigger": { "description": "What started this run", "enum": [ "manual", "scheduled" ], "title": "Trigger", "type": "string" }, "updated": { "description": "Sources replaced because their content changed", "title": "Updated", "type": "integer" } }, "required": [ "id", "connector_id", "status", "trigger", "discovered", "added", "updated", "removed", "skipped", "failed", "created_at" ], "title": "SyncRunRead", "type": "object" }, "TableHit": { "description": "What one `tabular_query` node found: the table it read, the query it built, and the rows\nthat came back. A retrieval run carries these beside its ranked `hits` rather than folding\nthem into an answer string -- rows are data, and a turn renders them as untrusted structured\ncontent (`docs/architecture/knowledge-and-memory.md`, \"A tool's own filter\").", "properties": { "columns": { "description": "the table's deduced schema", "items": { "$ref": "#/components/schemas/Column" }, "title": "Columns", "type": "array" }, "name": { "description": "the table's name", "title": "Name", "type": "string" }, "query": { "$ref": "#/components/schemas/RecordQuery", "description": "the typed query the model built and Core validated" }, "rows": { "description": "the rows the query returned", "items": { "additionalProperties": true, "type": "object" }, "title": "Rows", "type": "array" }, "source_id": { "description": "the source the table was extracted from", "title": "Source Id", "type": "string" }, "table_id": { "description": "the table that was queried", "title": "Table Id", "type": "string" } }, "required": [ "source_id", "table_id", "name", "columns", "query" ], "title": "TableHit", "type": "object" }, "TableQueryArgs": { "additionalProperties": false, "description": "A structured query the model calling a tool built itself: which offered table, and the\n`RecordQuery` over it. What a `tabular_query` step in `arguments` mode runs, after checking the\ntable is one it offered and the query fits that table's schema -- the gate a caller's own\nquery goes through (`docs/architecture/knowledge-and-memory.md`, \"Structured query\nvalidation\").", "properties": { "aggregate": { "anyOf": [ { "$ref": "#/components/schemas/RecordAggregate" }, { "type": "null" } ], "description": "Aggregation" }, "filters": { "description": "Filter expressions", "items": { "$ref": "#/components/schemas/RecordFilter" }, "title": "Filters", "type": "array" }, "group_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Group by field", "title": "Group By" }, "limit": { "default": 50, "description": "Result limit; bounded here, not only at each caller, since a query can also be built by a model (`tabular_query`) rather than sent by a caller", "maximum": 500.0, "minimum": 1.0, "title": "Limit", "type": "integer" }, "table_id": { "description": "the offered table to query", "maxLength": 64, "minLength": 1, "title": "Table Id", "type": "string" } }, "required": [ "table_id" ], "title": "TableQueryArgs", "type": "object" }, "TableRead": { "description": "One table extracted from a source, as `GET .../sources/{id}/tables` returns it: a\nworksheet, a CSV or JSON body, or one Markdown pipe table, with the schema and the rows that\nbelong to it alone (`docs/architecture/knowledge-and-memory.md`, \"A spreadsheet is many\ntables\").", "properties": { "created_at": { "description": "When this table was extracted", "format": "date-time", "title": "Created At", "type": "string" }, "id": { "description": "Knowledge table id", "title": "Id", "type": "string" }, "name": { "description": "The worksheet's name, the heading above a pipe table, or 'table-'", "title": "Name", "type": "string" }, "object": { "const": "knowledge_table", "default": "knowledge_table", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "description": "Where this table's rows came from", "enum": [ "sheet", "csv", "json", "markdown" ], "title": "Origin", "type": "string" }, "position": { "description": "0-based order of this table within its source", "title": "Position", "type": "integer" }, "row_count": { "description": "Rows stored for this table", "title": "Row Count", "type": "integer" }, "schema": { "additionalProperties": true, "description": "Deduced column schema for this table: {columns: [{name, type}]}", "title": "Schema", "type": "object" }, "source_id": { "description": "Source this table was extracted from", "title": "Source Id", "type": "string" }, "updated_at": { "description": "When this table was last written", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "source_id", "position", "name", "origin", "schema", "row_count", "created_at", "updated_at" ], "title": "TableRead", "type": "object" }, "TaskMessageCreate": { "additionalProperties": false, "description": "A message to a running agent task.", "properties": { "input": { "description": "what to tell the agent; appended to its own thread as an untrusted user message, which it reads before its next round", "maxLength": 64000, "minLength": 1, "title": "Input", "type": "string" } }, "required": [ "input" ], "title": "TaskMessageCreate", "type": "object" }, "TaskRead": { "description": "A task, as the API returns it.", "properties": { "arguments": { "additionalProperties": true, "description": "The arguments the call was started with", "title": "Arguments", "type": "object" }, "call_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The model's own id for the call that started the task, equal to the `call_id` of that call's execution on the trace. Null when the id was too long to keep (over about 90 characters): `call_id_sha256` then names it", "title": "Call Id" }, "call_id_sha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The hex SHA-256 of the call id (UTF-8), set exactly when `call_id` is null because the id was too long to keep; compare it to the digest of the trace call's `call_id`. Null otherwise", "title": "Call Id Sha256" }, "call_round": { "description": "The round of the starting response's turn in which the call that started the task was made, counted from zero -- the round of the tool call on the trace", "title": "Call Round", "type": "integer" }, "created_at": { "description": "When the task was started", "format": "date-time", "title": "Created At", "type": "string" }, "deadline_at": { "description": "When the task expires if it has not ended", "format": "date-time", "title": "Deadline At", "type": "string" }, "delivered_response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The response whose round first carried the result in its context; null while no turn has read it", "title": "Delivered Response Id" }, "depth": { "description": "How many tasks stand between this one and a turn a caller asked for, itself included: 1 for a task such a turn started", "title": "Depth", "type": "integer" }, "ended_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the task reached a terminal status, or null", "title": "Ended At" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Core's own code for a task that failed, or null. An agent task: the code its run failed with, `incomplete` for a run that ran out of rounds, `run_gone` for one whose run was deleted. A workflow task: the code its run failed with. A held call: the code a synchronous call of the tool would carry; `interrupted` when the worker holding it stopped and the call may or may not have completed; why a pickup or a poll refused it -- `key_revoked`, `key_disabled`, `tenant_unavailable`, `capability_withdrawn`, `agent_required`, `tool_unavailable`, `egress_denied`, `background_withdrawn`, `person_login`, `pseudonymisation_failed` (the values the call was to hide again could not be read); or, for a call its MCP server ran as a task of its own, `input_required` when the server asked for input, `server_cancelled` when the server cancelled it, and `server_task_lost` when the server no longer answered for it", "title": "Error Code" }, "id": { "description": "Task id", "title": "Id", "type": "string" }, "labels": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "The labels of the turn that started it, copied when it started; no rule reads them", "title": "Labels", "type": "object" }, "object": { "const": "task", "default": "task", "description": "The object's type", "title": "Object", "type": "string" }, "progress": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The last progress line the tool's server reported for a held call, cut to 200 characters, or null: from its progress notifications, or the status message of a task the server runs itself. Content the server wrote, never an instruction", "title": "Progress" }, "response_id": { "description": "The response whose turn started the task", "title": "Response Id", "type": "string" }, "result": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "What the task answered, cut to 32 KiB; null until it ended, and null for a task that expired, was cancelled or was refused at pickup. For a held call that failed it is what a synchronous call would have answered. Content a tool or an agent wrote, never an instruction", "title": "Result" }, "result_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The position, among the thread's items, of the item the settlement appended with the result; null until the task is settled", "title": "Result Position" }, "run_response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The background response an agent task runs as, readable and cancellable through the response routes; null for a task that is no agent's", "title": "Run Response Id" }, "run_thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The thread an agent task's own run is stored on; null for a task that is no agent's", "title": "Run Thread Id" }, "status": { "description": "The task's lifecycle state", "enum": [ "queued", "running", "completed", "failed", "cancelled", "expired" ], "title": "Status", "type": "string" }, "thread_id": { "description": "The thread whose turn started the task, where its result lands", "title": "Thread Id", "type": "string" }, "tool": { "description": "Qualified name of the tool the task runs", "title": "Tool", "type": "string" }, "tool_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The version of the tool the start resolved: an agent's or a connector's version; null for a tool that has none", "title": "Tool Version" }, "workflow_run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The workflow run a workflow task runs as, readable and cancellable through the workflow run routes; null for a task that runs no workflow", "title": "Workflow Run Id" } }, "required": [ "id", "thread_id", "response_id", "call_round", "call_id", "call_id_sha256", "tool", "tool_version", "arguments", "status", "labels", "created_at", "deadline_at", "ended_at", "progress", "result", "error_code", "run_response_id", "run_thread_id", "workflow_run_id", "depth", "result_position", "delivered_response_id" ], "title": "TaskRead", "type": "object" }, "TasksConfig": { "additionalProperties": false, "description": "The `tasks` capability: tool calls and agents that outlive the round that started them,\nwhich is why it needs `runs` and `threads` (`docs/architecture/tasks.md#the-capability`).", "properties": { "max_open_per_thread": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "open tasks one thread may hold, at most the deployment's; None is that", "title": "Max Open Per Thread" }, "wake": { "default": true, "description": "whether a late result starts a turn for it", "title": "Wake", "type": "boolean" } }, "title": "TasksConfig", "type": "object" }, "TenantAdminCreate": { "additionalProperties": false, "description": "Body of `POST /tenants/{tenant_id}/admins`.", "properties": { "email": { "description": "Email address to invite; it is also the address this person signs in with", "maxLength": 320, "minLength": 3, "pattern": "^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$", "title": "Email", "type": "string" }, "name": { "anyOf": [ { "maxLength": 200, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Display name for this person, when it is known", "title": "Name" } }, "required": [ "email" ], "title": "TenantAdminCreate", "type": "object" }, "TenantAdminInviteSent": { "description": "What re-sending an invitation did.", "properties": { "invite_sent": { "description": "Whether the invitation email was sent; false when this deployment cannot send email, or when this person had nothing left to finish and so needed none", "title": "Invite Sent", "type": "boolean" } }, "required": [ "invite_sent" ], "title": "TenantAdminInviteSent", "type": "object" }, "TenantAdminInvited": { "description": "One person who administers this organisation, as the invitation that added them left\nthem.", "properties": { "active": { "description": "Whether this administrator can actually administer this organisation. False means their invitation stopped part way through and left them able to sign in but not to act; re-sending the invitation puts it right", "title": "Active", "type": "boolean" }, "created": { "description": "Whether the invitation created a new account, rather than adding an account that already existed to this organisation", "title": "Created", "type": "boolean" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this administrator's account was created; null when it is not recorded", "title": "Created At" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Email address this administrator signs in with", "title": "Email" }, "email_verified": { "description": "Whether this administrator has confirmed their email address", "title": "Email Verified", "type": "boolean" }, "enabled": { "description": "Whether this administrator may sign in at all", "title": "Enabled", "type": "boolean" }, "id": { "description": "Identifier of this administrator", "title": "Id", "type": "string" }, "invite_pending": { "description": "Whether this administrator still has something to finish before they can sign in, such as choosing a password", "title": "Invite Pending", "type": "boolean" }, "invite_sent": { "description": "Whether the invitation email was sent; false when this deployment cannot send email, or when this person had nothing left to finish and so needed none", "title": "Invite Sent", "type": "boolean" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name, when this administrator has one", "title": "Name" }, "object": { "const": "tenant_admin", "default": "tenant_admin", "description": "The object's type", "title": "Object", "type": "string" }, "operator": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "On the deployment's support organisation, which only an operator of this deployment reaches: whether this administrator is one. False means they reach nothing here and are listed to be removed. Null on every other organisation", "title": "Operator" } }, "required": [ "id", "email", "name", "enabled", "email_verified", "invite_pending", "active", "created_at", "created", "invite_sent" ], "title": "TenantAdminInvited", "type": "object" }, "TenantAdminRead": { "description": "One person who administers this organisation.", "properties": { "active": { "description": "Whether this administrator can actually administer this organisation. False means their invitation stopped part way through and left them able to sign in but not to act; re-sending the invitation puts it right", "title": "Active", "type": "boolean" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this administrator's account was created; null when it is not recorded", "title": "Created At" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Email address this administrator signs in with", "title": "Email" }, "email_verified": { "description": "Whether this administrator has confirmed their email address", "title": "Email Verified", "type": "boolean" }, "enabled": { "description": "Whether this administrator may sign in at all", "title": "Enabled", "type": "boolean" }, "id": { "description": "Identifier of this administrator", "title": "Id", "type": "string" }, "invite_pending": { "description": "Whether this administrator still has something to finish before they can sign in, such as choosing a password", "title": "Invite Pending", "type": "boolean" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name, when this administrator has one", "title": "Name" }, "object": { "const": "tenant_admin", "default": "tenant_admin", "description": "The object's type", "title": "Object", "type": "string" }, "operator": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "On the deployment's support organisation, which only an operator of this deployment reaches: whether this administrator is one. False means they reach nothing here and are listed to be removed. Null on every other organisation", "title": "Operator" } }, "required": [ "id", "email", "name", "enabled", "email_verified", "invite_pending", "active", "created_at" ], "title": "TenantAdminRead", "type": "object" }, "TenantCreate": { "additionalProperties": false, "description": "Body of `POST /tenants`.", "properties": { "compute_ref": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "description": "Which compute pool this organisation's computers run on: omit for the default, which is the organisation above it's own (the deployment's default pool for a root); name a pool or placement this deployment configures to take another, which becomes the default for everything created under this organisation in turn. Only an operator may name one -- a tenant administrator or a key gets 403, and an unconfigured name gets 422", "title": "Compute Ref" }, "computer_internet": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this organisation's computers may reach the internet, where this deployment offers that and the caller's policy restricts no destination; set by this organisation's own administrators or anyone above it. Off above is off below: it is in force only where every organisation above is on too. Null, or omitted, copies the parent's: on where it is on and in force for the parent, off otherwise and for a root organisation. True is refused while the switch is not in force for the organisation it is created under; false is always accepted", "title": "Computer Internet" }, "database_ref": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "description": "Which physical database this organisation lives on: omit for the default, which is the organisation above it's own (Core's own database for a root); name a configured entry of Settings.tenant_databases to take a different one instead, which becomes the default for everything created under this organisation in turn. Only an operator may name one, root or child alike -- a tenant administrator or a key gets 403, and an unconfigured name gets 422", "title": "Database Ref" }, "isolation": { "default": "shared", "description": "How this organisation's rows are kept apart inside the database it lives on, chosen once, at provisioning: 'shared' is row-level security in that database's common tenant schema, 'schema' is a schema and database role of its own. A child chooses this for itself, whatever its parent chose", "enum": [ "shared", "schema" ], "title": "Isolation", "type": "string" }, "metadata": { "additionalProperties": true, "description": "An opaque document the new organisation attaches to itself, at most 16 KiB serialised: stored, returned and never read by Core -- where a platform keeps its own branding. Leave the field out to start with {}; PATCH replaces it later", "title": "Metadata", "type": "object" }, "name": { "description": "Human-readable tenant name", "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" }, "parent_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "The organisation the new one sits under; null creates a root organisation, which only an operator may do", "title": "Parent Id" }, "permitted_capabilities": { "anyOf": [ { "items": { "enum": [ "threads", "compaction", "runs", "tooling", "artifacts", "files", "skills", "prompts", "knowledge", "memory", "pseudonymisation", "agents", "evaluations", "schedules", "management", "subjects", "datastores", "assist", "trust_envelope", "computer", "tasks", "improvements", "workflows", "product_events" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Ceiling of capability names any key of this tenant may enable; null, or omitted, means everything this organisation may have -- the parent's own ceiling for a child, the whole catalogue for a root organisation. An empty list means nothing at all", "title": "Permitted Capabilities" }, "subscriptions": { "description": "Publications to install into the new organisation at provisioning -- how a partner bootstraps a client from its own library. Each is checked exactly as `POST /tenants/{id}/subscriptions` checks one, against the *parent's* place in the tree, and nothing is installed until the placement exists", "items": { "$ref": "#/components/schemas/SubscriptionCreate" }, "maxItems": 64, "title": "Subscriptions", "type": "array" }, "tool_search_permitted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this organisation's keys, agents and requests may route its tools through a search; null, or omitted, takes the parent's value for a child and true for a root organisation. True under a parent that is false is refused", "title": "Tool Search Permitted" } }, "required": [ "name" ], "title": "TenantCreate", "type": "object" }, "TenantRead": { "description": "A tenant, as the operator API returns it.", "properties": { "admin_restrictions": { "description": "What this organisation's own administrators may not do because a parent reserved it: 'usage' withholds its usage, 'audit' its audit trail, 'keys' every write to its API keys. Empty when the parent has reserved nothing", "items": { "enum": [ "usage", "audit", "keys" ], "type": "string" }, "title": "Admin Restrictions", "type": "array" }, "analysis_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The catalogue chat model this organisation chose for its improvement analyses; null when it follows the deployment's default. GET /improvements/model answers which model is in force", "title": "Analysis Model" }, "assist_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The catalogue chat model this organisation chose for its helpers; null when it follows the deployment's default. GET /assist answers which model is in force", "title": "Assist Model" }, "audit_retention_days": { "description": "How long this tenant's audit, usage and control rows are kept before the retention pass deletes them", "title": "Audit Retention Days", "type": "integer" }, "capabilities_in_force": { "description": "The capabilities this organisation's keys and administrators may use now: permitted_capabilities narrowed by the ceiling of every organisation above it, in the same order, every capability included. Read-only; permitted_capabilities is the stored ceiling an administrator above edits, and a narrowing above changes this field without rewriting that one", "items": { "enum": [ "threads", "compaction", "runs", "tooling", "artifacts", "files", "skills", "prompts", "knowledge", "memory", "pseudonymisation", "agents", "evaluations", "schedules", "management", "subjects", "datastores", "assist", "trust_envelope", "computer", "tasks", "improvements", "workflows", "product_events" ], "type": "string" }, "title": "Capabilities In Force", "type": "array" }, "compute_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Which compute pool this organisation's computers run on, its effective value whichever way it got there: null is the deployment's default pool, a name is a configured one -- the organisation above it's own by default, or one an operator named", "title": "Compute Ref" }, "computer_internet": { "default": false, "description": "Whether this organisation's computers may reach the internet, where this deployment offers that and the caller's policy restricts no destination; set by this organisation's own administrators or anyone above it. Off above is off below: it is in force only where every organisation above is on too", "title": "Computer Internet", "type": "boolean" }, "computer_internet_available": { "default": false, "description": "Whether this deployment offers computers that reach the internet at all (its operator's computers_accept_open_egress). While false the switch is kept and does nothing", "title": "Computer Internet Available", "type": "boolean" }, "computer_internet_in_force": { "default": false, "description": "Whether computer_internet is on for this organisation and for every organisation above it. Read-only; an organisation above turning its own off changes this field without rewriting computer_internet", "title": "Computer Internet In Force", "type": "boolean" }, "created_at": { "description": "When the tenant was created", "format": "date-time", "title": "Created At", "type": "string" }, "data_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "How long this organisation's own content is kept before the data retention pass deletes it, counted from when each row was created; null keeps it for ever", "title": "Data Retention Days" }, "database_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Which physical database this organisation lives on, its effective value whichever way it got there: null is Core's own, a name is a configured dedicated one -- the organisation above it's own by default, or one an operator named directly for this organisation. Never a connection string -- the ref is a name", "title": "Database Ref" }, "id": { "description": "Tenant id", "title": "Id", "type": "string" }, "inheritable_keys": { "description": "The top-level keys of metadata this organisation lends to the organisations below it; empty when it lends none", "items": { "type": "string" }, "title": "Inheritable Keys", "type": "array" }, "isolation": { "description": "How this organisation's rows are kept apart inside the database it lives on: 'shared' is row-level security in that database's common tenant schema, 'schema' is a schema and database role of its own", "enum": [ "shared", "schema" ], "title": "Isolation", "type": "string" }, "legal_hold": { "description": "While true, nothing of this tenant's is ever deleted by a retention pass -- neither its trail nor its content", "title": "Legal Hold", "type": "boolean" }, "memory_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Days memory records are kept, from each record's last write or confirmation; null leaves memory under data_retention_days", "title": "Memory Retention Days" }, "metadata": { "additionalProperties": true, "description": "The opaque document this organisation attached to itself; {} when it set none", "title": "Metadata", "type": "object" }, "metadata_version": { "description": "The version of metadata as it is stored now; name it in If-Match on PATCH and the save is refused 409 when metadata changed after this read", "title": "Metadata Version", "type": "string" }, "monthly_cost_cap_counts": { "$ref": "#/components/schemas/CapCounts", "description": "What the monthly cap is weighed against: `branch`, what this organisation and every organisation below it used, or `own`, what this organisation itself used. It has no effect while monthly_cost_cap_eur is null" }, "monthly_cost_cap_counts_erased": { "description": "Whether a cap that counts the branch goes on counting what an organisation erased from the branch used in the month it was erased, until that month ends. It has no effect while monthly_cost_cap_eur is null or monthly_cost_cap_counts is `own`", "title": "Monthly Cost Cap Counts Erased", "type": "boolean" }, "monthly_cost_cap_eur": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Ceiling on what this organisation may spend in a calendar month (UTC), in euro; null when it has none", "title": "Monthly Cost Cap Eur" }, "monthly_cost_cap_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the monthly cap stops binding -- the end of the cap period it was set in -- or null for a standing cap. A cap past it binds nobody and is still shown here", "title": "Monthly Cost Cap Until" }, "name": { "description": "Human-readable tenant name", "title": "Name", "type": "string" }, "notification_channels": { "description": "The channels this organisation is notified through about itself; both 'mail' and 'slack' unless it chose otherwise", "items": { "enum": [ "mail", "slack" ], "type": "string" }, "title": "Notification Channels", "type": "array" }, "notification_emails": { "description": "The addresses this organisation itself set for its notification mail; empty when it set none and falls back to an organisation above it", "items": { "type": "string" }, "title": "Notification Emails", "type": "array" }, "notification_emails_effective": { "description": "Where this organisation's notification mail goes when 'mail' is among its channels: its own addresses, or the whole list of the nearest organisation above it that set any; empty when nobody on the way up did, and then no mail is sent", "items": { "type": "string" }, "title": "Notification Emails Effective", "type": "array" }, "notification_emails_inherited_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the organisation above this one whose addresses notification_emails_effective are, when they are inherited and the caller reaches that organisation; null when the addresses are this organisation's own, when there are none, or when they belong to an organisation the caller does not administer", "title": "Notification Emails Inherited From" }, "notification_failure_analysis": { "description": "Whether a failures digest about this organisation carries an analysis its helper model wrote from what failed; false unless the organisation turned it on", "title": "Notification Failure Analysis", "type": "boolean" }, "notification_failures_available": { "default": false, "description": "Whether this deployment's operator has switched the failures digest on. The same for every organisation; while false, no failure is noted, no 'failures.digest' is sent and notification_failure_analysis has no effect", "title": "Notification Failures Available", "type": "boolean" }, "notification_kinds_disabled": { "description": "The kinds of notification mail this organisation turned off about itself; empty when every kind is on", "items": { "enum": [ "usage.threshold_reached", "usage.monthly_summary", "webhook.failing", "integration.failed", "failures.digest", "model.deprecated", "workflow.decision_requested", "check.failing", "task.finished" ], "type": "string" }, "title": "Notification Kinds Disabled", "type": "array" }, "notification_kinds_enabled": { "description": "The opt-in kinds of notification this organisation asked for; empty if none", "items": { "enum": [ "usage.threshold_reached", "usage.monthly_summary", "webhook.failing", "integration.failed", "failures.digest", "model.deprecated", "workflow.decision_requested", "check.failing", "task.finished" ], "type": "string" }, "title": "Notification Kinds Enabled", "type": "array" }, "notification_language": { "description": "The language every notification mail and Slack message about this organisation is written in; 'nl' unless it chose 'en'", "enum": [ "nl", "en" ], "title": "Notification Language", "type": "string" }, "notification_slack_available": { "default": false, "description": "Whether this deployment's operator has switched Slack notifications on. The same for every organisation; while false, storing a Slack webhook answers 409 and no message is posted to one already stored", "title": "Notification Slack Available", "type": "boolean" }, "notification_slack_effective": { "default": false, "description": "Whether a Slack webhook resolves for this organisation: its own, or that of the nearest organisation above it that stored one. A message is posted only when 'slack' is also among its channels and the deployment has Slack notifications on", "title": "Notification Slack Effective", "type": "boolean" }, "notification_slack_egress": { "anyOf": [ { "$ref": "#/components/schemas/HostAccess" }, { "type": "null" } ], "description": "Where Slack's host stands for the webhook this organisation is notified through: `allowed` when the rules over `egress_host` of the organisation that stored the webhook permit hooks.slack.com, `blocked` when the deployment blocks it. A post is made only when it is allowed and not blocked, and regions are not weighed here: an owner that narrows its regions may read allowed and still be refused until it places and admits the host, and an organisation that inherits the webhook and restricts its own regions is held to those too at delivery, where an entry for host:hooks.slack.com among its own region_exceptions admits it. Computed on every read. Null when no webhook resolves, and when the webhook is inherited from an organisation the caller does not administer, whose policy is not the caller's to read" }, "notification_slack_inherited_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the organisation above this one whose Slack webhook this organisation is notified through, when it is inherited and the caller reaches that organisation; null when the webhook is its own, when there is none, or when it belongs to an organisation the caller does not administer", "title": "Notification Slack Inherited From" }, "notification_slack_set": { "default": false, "description": "Whether this organisation itself stored a Slack webhook. The webhook is never returned", "title": "Notification Slack Set", "type": "boolean" }, "object": { "const": "tenant", "default": "tenant", "description": "The object's type", "title": "Object", "type": "string" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The organisation this one sits under; null for a root organisation", "title": "Parent Id" }, "permitted_capabilities": { "description": "Ceiling of capability names any key of this tenant may enable", "items": { "enum": [ "threads", "compaction", "runs", "tooling", "artifacts", "files", "skills", "prompts", "knowledge", "memory", "pseudonymisation", "agents", "evaluations", "schedules", "management", "subjects", "datastores", "assist", "trust_envelope", "computer", "tasks", "improvements", "workflows", "product_events" ], "type": "string" }, "title": "Permitted Capabilities", "type": "array" }, "product_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "That product's display name, copied onto every event it delivers; set together with product_namespace, null when it is", "title": "Product Name" }, "product_namespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The namespace a product built on Core delivers its own audit events under, for keys of this organisation and of every organisation below it that sets none of its own; null when none", "title": "Product Namespace" }, "reasoning_summaries_enabled": { "description": "Whether a turn on a thinking model asks for the model's reasoning back in readable form by default, for every key of this organisation that has not said otherwise", "title": "Reasoning Summaries Enabled", "type": "boolean" }, "routing_config_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "This organisation's default routing configuration; null for none", "title": "Routing Config Id" }, "status": { "description": "'active', 'suspended', 'provisioning' or 'deleting'", "enum": [ "active", "suspended", "provisioning", "deleting" ], "title": "Status", "type": "string" }, "suspended_by_ancestor": { "default": false, "description": "Whether an organisation above this one is suspended. While true this organisation's keys are refused and its runs and schedules are stopped as if it were suspended itself, and its own `status` stays what it was", "title": "Suspended By Ancestor", "type": "boolean" }, "timezone": { "description": "The IANA zone this organisation's turns read a prompt's time values in when neither the request nor a schedule names one; UTC unless the organisation chose another", "title": "Timezone", "type": "string" }, "tool_search_permitted": { "description": "Whether this organisation's keys, agents and requests may route its tools through a search rather than offer them to the model directly; its parent decides", "title": "Tool Search Permitted", "type": "boolean" }, "trace_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "How long this organisation's traces are kept before the data retention pass deletes them; null gives them no window of their own and leaves them under data_retention_days, which a trace never outlives either way", "title": "Trace Retention Days" }, "tracing_enabled": { "description": "Whether this organisation's model calls are traced -- one record per call holding what the provider received, readable through the trace routes", "title": "Tracing Enabled", "type": "boolean" }, "updated_at": { "description": "When the tenant was last updated", "format": "date-time", "title": "Updated At", "type": "string" }, "usage_alert_thresholds": { "description": "The percentages of a monthly cap at which this organisation is mailed, ascending; [80, 100] unless it chose others", "items": { "type": "integer" }, "title": "Usage Alert Thresholds", "type": "array" } }, "required": [ "id", "name", "parent_id", "isolation", "database_ref", "compute_ref", "permitted_capabilities", "admin_restrictions", "tool_search_permitted", "status", "audit_retention_days", "legal_hold", "data_retention_days", "trace_retention_days", "memory_retention_days", "tracing_enabled", "reasoning_summaries_enabled", "monthly_cost_cap_eur", "monthly_cost_cap_until", "monthly_cost_cap_counts", "monthly_cost_cap_counts_erased", "routing_config_id", "assist_model", "analysis_model", "timezone", "metadata", "metadata_version", "inheritable_keys", "notification_emails", "notification_channels", "usage_alert_thresholds", "notification_kinds_disabled", "notification_kinds_enabled", "notification_failure_analysis", "notification_language", "created_at", "updated_at" ], "title": "TenantRead", "type": "object" }, "TenantUpdate": { "additionalProperties": false, "description": "Body of `PATCH /tenants/{tenant_id}`; every field is optional and left alone when absent.", "properties": { "admin_restrictions": { "anyOf": [ { "items": { "enum": [ "usage", "audit", "keys" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "What this organisation's own administrators may not do because a parent reserved it: 'usage', 'audit' and 'keys' each withhold one surface. Set by an administrator of an organisation above this one, or by an operator; this organisation's own administrators get 403 naming the field", "title": "Admin Restrictions" }, "analysis_model": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "description": "The catalogue chat model this organisation's improvement analyses call, which must be one this organisation may use; send null to follow the deployment's default, leave the field out to keep what it has. Set as assist_model is, under the same 'keys' reservation", "title": "Analysis Model" }, "assist_model": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "description": "The catalogue chat model this organisation's helpers call, which must be one this organisation may use; send null to follow the deployment's default, leave the field out to keep what it has. Whoever may set the default routing configuration may set this, under the same 'keys' reservation", "title": "Assist Model" }, "audit_retention_days": { "anyOf": [ { "maximum": 3650.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "How long this tenant's audit, usage and control rows are kept before the retention pass deletes them; operator only", "title": "Audit Retention Days" }, "computer_internet": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this organisation's computers may reach the internet, where this deployment offers that and the caller's policy restricts no destination; set by this organisation's own administrators or anyone above it. Off above is off below: it is in force only where every organisation above is on too. True is refused while an organisation above has it off; false is always accepted, and turns it off for every organisation below too", "title": "Computer Internet" }, "data_retention_days": { "anyOf": [ { "maximum": 3650.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "How long this organisation's own content -- threads, terminal responses, files, artifacts and memory records -- is kept before the data retention pass deletes it, counted from when each row was created; send null to keep it for ever, leave the field out to keep what it has. Whoever may set the organisation's name may set this", "title": "Data Retention Days" }, "inheritable_keys": { "anyOf": [ { "items": { "maxLength": 128, "minLength": 1, "type": "string" }, "maxItems": 32, "type": "array" }, { "type": "null" } ], "description": "The top-level keys of metadata the organisations below this one read as their own where their own metadata lacks the key, at most 32, each once, in the order sent. Replaces the whole list; send [] to lend nothing. A key not listed never flows down. Whoever may set metadata may set this; leave the field out to keep what it has", "title": "Inheritable Keys" }, "legal_hold": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "While true, nothing of this tenant's is ever deleted by a retention pass -- neither its trail nor its content -- erased tenant included; operator only", "title": "Legal Hold" }, "memory_retention_days": { "anyOf": [ { "maximum": 3650.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "Days memory records are kept, from each record's last write or confirmation; an open commitment never expires. Null leaves memory under data_retention_days, an absent field keeps it. Whoever may set data_retention_days may set this", "title": "Memory Retention Days" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document this organisation attaches to itself, at most 16 KiB serialised: stored, returned and never read by Core -- where a platform keeps its own branding. Leave the field out to keep what it has, and send {} to clear it. Whoever may set the organisation's name may set this; an organisation below this one reads only the keys inheritable_keys lists, through GET .../metadata/effective", "title": "Metadata" }, "monthly_cost_cap_counts": { "anyOf": [ { "$ref": "#/components/schemas/CapCounts" }, { "type": "null" } ], "description": "What the monthly cap is weighed against: `branch`, what this organisation and every organisation below it used, or `own`, what this organisation itself used. Under either, an organisation at its cap stops every organisation below it. Leave the field out to keep what it has; a new organisation has `branch`. It is stored and has no effect while monthly_cost_cap_eur is null. Set by whoever may set the cap; this organisation's own administrators get 403 naming the field" }, "monthly_cost_cap_counts_erased": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether a cap that counts the branch goes on counting what an organisation erased from the branch used in the month it was erased, until that month ends. Leave the field out to keep what it has; a new organisation has true. It is stored and has no effect while monthly_cost_cap_eur is null or monthly_cost_cap_counts is `own`. Set by whoever may set the cap; this organisation's own administrators get 403 naming the field", "title": "Monthly Cost Cap Counts Erased" }, "monthly_cost_cap_eur": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Ceiling on what this organisation may spend in a calendar month (UTC), in euro; send null to lift it. 0 is a real cap -- nothing priced at all until the month turns. Counts every priced kind. Set by an operator anywhere, and by an administrator of an organisation above this one; this organisation's own administrators get 403 naming the field", "title": "Monthly Cost Cap Eur" }, "monthly_cost_cap_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the monthly cap stops binding: only the end of the current cap period, the first instant of next month at 00:00:00 UTC, so a cap for this month only lifts by itself as the month turns; any other instant is 422. Null makes the cap standing. A cap sent without this field keeps an end still to come, lifting the cap clears it, and sending it with no binding cap to end is 422. Set by whoever may set the cap", "title": "Monthly Cost Cap Until" }, "name": { "anyOf": [ { "maxLength": 200, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Human-readable tenant name", "title": "Name" }, "notification_channels": { "anyOf": [ { "items": { "enum": [ "mail", "slack" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The channels this organisation is notified through about itself: any of 'mail' and 'slack'. A channel sends when it is listed here and a destination resolves for it, this organisation's own or the nearest above it; leaving 'slack' out is how an organisation declines a Slack channel it would inherit. Replaces the whole list; leave the field out or send null to keep what it has", "title": "Notification Channels" }, "notification_emails": { "anyOf": [ { "items": { "maxLength": 254, "minLength": 3, "type": "string" }, "maxItems": 10, "type": "array" }, { "type": "null" } ], "description": "The addresses Core mails about this organisation: budget thresholds, failing webhooks and integrations, the monthly summary. At most ten, each once; every notification is one message to all of them. Replaces the whole list; send [] to clear it, after which mail goes to the whole list of the nearest organisation above this one that set any; leave the field out or send null to keep what it has. Whoever may set the organisation's name may set this", "title": "Notification Emails" }, "notification_failure_analysis": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether a failures digest about this organisation carries an analysis written by the organisation's helper model from what failed. Turning it on lets that model read the digest's counts, codes and names and the provider's own error body of a few failed model calls, and its answer travels by every channel the digest does, Slack included. Has no effect while notification_failures_available is false. Leave the field out or send null to keep what it has. Whoever may set the organisation's name may set this", "title": "Notification Failure Analysis" }, "notification_kinds_disabled": { "anyOf": [ { "items": { "enum": [ "usage.threshold_reached", "usage.monthly_summary", "webhook.failing", "integration.failed", "failures.digest", "model.deprecated", "workflow.decision_requested", "check.failing", "task.finished" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The kinds of notification mail this organisation does not want about itself: 'usage.threshold_reached', 'usage.monthly_summary', 'webhook.failing', 'integration.failed', 'failures.digest'. Replaces the whole list; send [] to turn every kind back on, leave the field out or send null to keep what it has. An organisation below this one that only inherits its address is not filtered by this list, only by its own", "title": "Notification Kinds Disabled" }, "notification_kinds_enabled": { "anyOf": [ { "items": { "enum": [ "usage.threshold_reached", "usage.monthly_summary", "webhook.failing", "integration.failed", "failures.digest", "model.deprecated", "workflow.decision_requested", "check.failing", "task.finished" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The opt-in kinds of notification this organisation asks for: 'task.finished', off until listed; any other kind is refused with 422. Replaces the whole list; send [] to turn them off, leave the field out or send null to keep it", "title": "Notification Kinds Enabled" }, "notification_language": { "anyOf": [ { "enum": [ "nl", "en" ], "type": "string" }, { "type": "null" } ], "description": "The language every notification mail and Slack message about this organisation is written in: 'nl' or 'en'. A mail it inherits an address for from an organisation above is still written in its own language. Leave the field out or send null to keep what it has. Whoever may set the organisation's name may set this", "title": "Notification Language" }, "notification_slack_webhook_url": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The Slack incoming webhook this organisation is notified through: an https address on hooks.slack.com whose path starts with /services/. Stored sealed and never returned; notification_slack_set says whether one is stored. Send null to clear it, after which the nearest organisation above this one that set a webhook lends its channel; leave the field out to keep what it has. Refused with 409 until the deployment's operator has switched Slack notifications on", "title": "Notification Slack Webhook Url" }, "parent_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "Move this organisation under another one, or send null to make it a root organisation; operator only, and refused when the new parent is this organisation or one below it", "title": "Parent Id" }, "permitted_capabilities": { "anyOf": [ { "items": { "enum": [ "threads", "compaction", "runs", "tooling", "artifacts", "files", "skills", "prompts", "knowledge", "memory", "pseudonymisation", "agents", "evaluations", "schedules", "management", "subjects", "datastores", "assist", "trust_envelope", "computer", "tasks", "improvements", "workflows", "product_events" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Ceiling of capability names any key of this tenant may enable", "title": "Permitted Capabilities" }, "product_name": { "anyOf": [ { "pattern": "^[^\\s\\x00-\\x1f\\x7f](?:[^\\x00-\\x1f\\x7f]{0,62}[^\\s\\x00-\\x1f\\x7f])?$", "type": "string" }, { "type": "null" } ], "description": "That product's display name, copied onto every event it delivers; set together with product_namespace, null when it is. Plain text, 1 to 64 characters; send null to clear it, leave the field out to keep it. A rename leaves events already delivered as they were; operator only", "title": "Product Name" }, "product_namespace": { "anyOf": [ { "pattern": "^[a-z][a-z0-9]{1,15}$", "type": "string" }, { "type": "null" } ], "description": "The namespace a product built on Core delivers its own audit events under, for keys of this organisation and of every organisation below it that sets none of its own; null when none. Send null to clear it, leave the field out to keep it. Refused when it is the first segment of one of Core's own event names; operator only", "title": "Product Namespace" }, "reasoning_summaries_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether a turn on a thinking model asks for the model's reasoning back in readable form by default, for every key of this organisation that has not said otherwise; a request's or an agent's own reasoning.summary always wins. Leave the field out to keep what it has. Whoever may set the organisation's name may set this", "title": "Reasoning Summaries Enabled" }, "routing_config_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "This organisation's default routing configuration, which must be one of its own; send null to clear it, leave the field out to keep what it has. Whoever may set the organisation's name may set this, under the same 'keys' reservation", "title": "Routing Config Id" }, "status": { "anyOf": [ { "enum": [ "active", "suspended" ], "type": "string" }, { "type": "null" } ], "description": "'active' or 'suspended'; 409 while 'provisioning' or 'deleting'", "title": "Status" }, "timezone": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "The IANA zone this organisation's turns read a prompt's time values in when neither the request nor a schedule names one; leave the field out, or send null, to keep what it has -- there is no null to store, so a return to UTC is sent as 'UTC'. Whoever may set the organisation's name may set this, and an organisation below this one does not inherit it", "title": "Timezone" }, "tool_search_permitted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this organisation's keys, agents and requests may route its tools through a search; set by an administrator of an organisation above this one or an operator, and refused as true under a parent that is false. Turning it on queues every tool of the organisation for the search's index", "title": "Tool Search Permitted" }, "trace_retention_days": { "anyOf": [ { "maximum": 3650.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "How long this organisation's traces -- the calls its keys made to a model, with the bytes the provider received behind them -- are kept before the data retention pass deletes them, counted from when each call was made; send null to give them no window of their own, leave the field out to keep what it has. It can only shorten: a trace never outlives data_retention_days. Whoever may set that window may set this", "title": "Trace Retention Days" }, "tracing_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this organisation's model calls are traced -- one record per call holding what the provider received. Leave the field out to keep what it has. Whoever may set the organisation's name may set this; a deployment with tracing switched off traces nothing whatever this says", "title": "Tracing Enabled" }, "usage_alert_thresholds": { "anyOf": [ { "items": { "maximum": 100.0, "minimum": 1.0, "type": "integer" }, "maxItems": 5, "type": "array" }, { "type": "null" } ], "description": "The percentages of a monthly cap at which this organisation is mailed, once per threshold per cap per calendar month (UTC): whole numbers 1 to 100, each once, at most five; the same list applies to the organisation's own cap and to each of its keys'. Leave the field out, or send null, to keep what it has. Whoever may set the organisation's name may set this", "title": "Usage Alert Thresholds" } }, "title": "TenantUpdate", "type": "object" }, "Terms": { "additionalProperties": false, "description": "What a subscriber may do with one version of a publication.\n\nAll five are enforced: `fork` and `sealed` when a subscriber writes to or reads a copy,\n`redistribute` when it tries to publish one again (`app.sharing`), `entitlement`\nat subscribe time and at every sync (`app.sharing.entitlements`, `app.sharing.lapse`), and\n`own_agents_only` where a turn resolves a prompt or a skill (`app.definitions`).\n`license` is free text and `price` a figure a console shows; Core reads neither, except that a\nprice needs `entitlement` (`app.sharing.versions.check_terms`).", "properties": { "entitlement": { "default": false, "description": "whether subscribing needs a live entitlement; without one a subscribe is 403, and a lapse suspends the copies rather than deleting them", "title": "Entitlement", "type": "boolean" }, "fork": { "default": true, "description": "whether a subscriber may detach a copy and change it; refused together with `sealed`, since a fork would hand the subscriber the content the seal withholds", "title": "Fork", "type": "boolean" }, "license": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "description": "the licence text, shown to a subscriber", "title": "License" }, "own_agents_only": { "default": false, "description": "whether only the agents this publication installs may use its prompts and skills in a turn; a turn of the subscriber's own agent, of a forked copy of one, or of no agent that names such a copy is refused 403", "title": "Own Agents Only", "type": "boolean" }, "price": { "anyOf": [ { "$ref": "#/components/schemas/TermsPrice" }, { "type": "null" } ], "description": "the price the catalogue shows, which Core never charges; refused without `entitlement`, and a changed price is changed terms a subscriber accepts again" }, "redistribute": { "default": true, "description": "whether a member may appear in a bundle the subscriber itself publishes; checked transitively, through a copy of a copy", "title": "Redistribute", "type": "boolean" }, "sealed": { "default": false, "description": "whether every read model withholds the copies' content; a turn still runs them. Refused together with `fork`", "title": "Sealed", "type": "boolean" } }, "title": "Terms", "type": "object" }, "TermsPrice": { "additionalProperties": false, "description": "What the catalogue shows a publication costs. Core stores it and never charges it: the\npaying system outside Core writes the entitlement a price asks for\n(`docs/architecture/bundle-releases.md#prices`).", "properties": { "amount": { "description": "the price in the currency's major unit as a decimal string, above zero, at most two decimals", "pattern": "^\\d+(\\.\\d{1,2})?$", "title": "Amount", "type": "string" }, "currency": { "description": "ISO 4217 currency code, three upper-case letters", "pattern": "^[A-Z]{3}$", "title": "Currency", "type": "string" }, "period": { "description": "how often the amount is charged: once, every month or every year", "enum": [ "once", "month", "year" ], "title": "Period", "type": "string" } }, "required": [ "amount", "currency", "period" ], "title": "TermsPrice", "type": "object" }, "TextBlock": { "additionalProperties": false, "description": "The assistant's own generated text.", "properties": { "citations": { "description": "citations supporting this text; always null, because Core's own retrieval cites through `GET /artifacts` rather than inside a block", "title": "Citations", "type": "null" }, "text": { "description": "the assistant's text", "title": "Text", "type": "string" }, "type": { "const": "text", "default": "text", "description": "content block kind", "title": "Type", "type": "string" } }, "required": [ "text" ], "title": "TextBlock", "type": "object" }, "TextBlockIn": { "additionalProperties": false, "description": "A `text` block: the only block a `system` prompt may carry.", "properties": { "cache_control": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the vendor's prompt-cache hint; accepted and ignored: a hint that does not change what the answer means, so it is neither refused nor forwarded, stored or echoed", "title": "Cache Control" }, "citations": { "description": "always null, and declared so a caller can replay the vendor's own serialisation of an assistant message, where `citations: null` is written out. A quotation of a `document` block is not something Core answers, so a non-null value is refused by name rather than dropped (`docs/architecture/messages.md`)", "title": "Citations", "type": "null" }, "text": { "description": "the block's text, at most 1 MiB", "maxLength": 1048576, "title": "Text", "type": "string" }, "type": { "const": "text", "default": "text", "description": "content block kind", "title": "Type", "type": "string" } }, "required": [ "text" ], "title": "TextBlockIn", "type": "object" }, "TextFormat": { "additionalProperties": false, "description": "The output text format a turn must produce.", "properties": { "format": { "description": "the required output text format; plain text", "discriminator": { "mapping": { "json_schema": "#/components/schemas/JsonSchemaFormatParam", "text": "#/components/schemas/TextFormatText" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/TextFormatText" }, { "$ref": "#/components/schemas/JsonSchemaFormatParam" } ], "title": "Format" }, "verbosity": { "anyOf": [ { "enum": [ "low", "medium", "high" ], "type": "string" }, { "type": "null" } ], "description": "how long the answer should be; accepted and ignored: a hint that does not change what the answer means, so Core never forwards it, stores it or answers it back", "title": "Verbosity" } }, "title": "TextFormat", "type": "object" }, "TextFormatText": { "additionalProperties": false, "description": "The model must produce plain, unconstrained text.", "properties": { "type": { "const": "text", "default": "text", "description": "output format kind", "title": "Type", "type": "string" } }, "title": "TextFormatText", "type": "object" }, "TextSourceCreate": { "additionalProperties": false, "description": "Body of `POST /knowledge/collections/{id}/sources` for `kind: \"text\"`.", "properties": { "kind": { "const": "text", "description": "Source kind", "title": "Kind", "type": "string" }, "labels": { "default": {}, "description": "labels the rules over this row's kind read, as label -> a value or a list of 1 to 32 distinct values, each of 1 to 256 characters; at most 32 names. Held to the organisation's vocabulary and, for a request naming a person, to `writable_labels`", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "additionalProperties": { "maxLength": 2048, "type": "string" }, "description": "Metadata matched by a search's metadata filter", "maxProperties": 64, "propertyNames": { "maxLength": 128 }, "title": "Metadata", "type": "object" }, "text": { "description": "Source text. The whole request, this text with the title, metadata and labels, may be at most 1 MiB as compact JSON (a line break or a quote counts two bytes), the body the gateway accepts; for more text, upload a file with `POST .../sources/upload`", "minLength": 1, "title": "Text", "type": "string" }, "title": { "description": "Human-readable source title", "maxLength": 255, "minLength": 1, "title": "Title", "type": "string" } }, "required": [ "kind", "title", "text" ], "title": "TextSourceCreate", "type": "object" }, "ThinkingBlock": { "additionalProperties": false, "description": "The model's own thinking, as far as a caller may ever see it.", "properties": { "signature": { "default": "", "description": "always empty: the provider's real signature is replay state Core keeps on the stored item and hands back itself, never a caller's to hold (`docs/engineering/standard.md` §6)", "title": "Signature", "type": "string" }, "thinking": { "description": "the readable summary of this round's reasoning, empty when the model kept it to itself", "title": "Thinking", "type": "string" }, "type": { "const": "thinking", "default": "thinking", "description": "content block kind", "title": "Type", "type": "string" } }, "required": [ "thinking" ], "title": "ThinkingBlock", "type": "object" }, "ThinkingBlockIn": { "additionalProperties": false, "description": "A `thinking` block replayed on the request.\n\nAccepted and **not** replayed to the model: Core keeps each round's signed blocks on the\nreasoning item it stored (`CoreItem.content.provider_blocks`) and hands *those* back, so a\ncaller replaying an assistant turn neither has to carry a signature nor can break one\n(`docs/architecture/responses.md` \"Reasoning\").", "properties": { "signature": { "default": "", "description": "the vendor's signature, ignored by Core", "title": "Signature", "type": "string" }, "thinking": { "default": "", "description": "the reasoning text, ignored by Core", "title": "Thinking", "type": "string" }, "type": { "const": "thinking", "default": "thinking", "description": "content block kind", "title": "Type", "type": "string" } }, "title": "ThinkingBlockIn", "type": "object" }, "ThinkingIn": { "additionalProperties": false, "description": "What the caller asks of the model's own thinking.", "properties": { "budget_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "a fixed thinking budget; refused by Core", "title": "Budget Tokens" }, "display": { "anyOf": [ { "enum": [ "summarized", "omitted" ], "type": "string" }, { "type": "null" } ], "description": "whether the reasoning comes back readable", "title": "Display" }, "type": { "description": "the thinking mode", "enum": [ "adaptive", "enabled", "disabled" ], "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "ThinkingIn", "type": "object" }, "ThreadCreate": { "additionalProperties": false, "description": "A new thread, optionally seeded with items.", "properties": { "items": { "default": [], "description": "items to seed the thread with", "items": { "discriminator": { "mapping": { "custom_tool_call": "#/components/schemas/CustomToolCallInput", "custom_tool_call_output": "#/components/schemas/CustomToolCallOutputInput", "function_call": "#/components/schemas/FunctionCallInput", "function_call_output": "#/components/schemas/FunctionCallOutputInput", "message": "#/components/schemas/MessageInput", "reasoning": "#/components/schemas/ReasoningInput" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/MessageInput" }, { "$ref": "#/components/schemas/FunctionCallInput" }, { "$ref": "#/components/schemas/FunctionCallOutputInput" }, { "$ref": "#/components/schemas/CustomToolCallInput" }, { "$ref": "#/components/schemas/CustomToolCallOutputInput" }, { "$ref": "#/components/schemas/ReasoningInput" } ] }, "title": "Items", "type": "array" }, "labels": { "default": {}, "description": "labels the rules over this row's kind read, as label -> a value or a list of 1 to 32 distinct values, each of 1 to 256 characters; at most 32 names. Held to the organisation's vocabulary and, for a request naming a person, to `writable_labels`", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "default": {}, "description": "caller-supplied key/value pairs: the application's own, read by no rule except, for one release, a string under a name `labels` lack", "maxProperties": 16, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "maxLength": 512, "type": "string" } }, "title": "Metadata", "type": "object" }, "working_state_from": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "a thread whose working state this thread starts with, as a copy: one of the same named person's threads this request may read; a missing, foreign or unreadable one is 404. The copy is held to the deployment's bound", "title": "Working State From" } }, "title": "ThreadCreate", "type": "object" }, "ThreadCustomToolCall": { "additionalProperties": false, "description": "A free-text call on a tool the caller runs, with the response and the person that wrote\nit.", "properties": { "call_id": { "description": "id correlating this call with its result", "title": "Call Id", "type": "string" }, "id": { "description": "the item's id", "title": "Id", "type": "string" }, "input": { "description": "the call's free-text input, as the model wrote it", "title": "Input", "type": "string" }, "name": { "description": "the custom tool's name; inside its namespace, when it has one", "title": "Name", "type": "string" }, "namespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the `namespace` tools[] entry the called tool belongs to, so the caller routes the call to the tool it declared; null for a tool offered on its own", "title": "Namespace" }, "response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "id of the response whose turn wrote this item, which opens that answer's trace; null for an item a caller appended", "title": "Response Id" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "id of the person the request that wrote this item was for -- who wrote it, in a thread several people write in; null when that request named nobody, and on items written before authors were kept", "title": "Subject" }, "type": { "const": "custom_tool_call", "default": "custom_tool_call", "description": "output item kind", "title": "Type", "type": "string" } }, "required": [ "id", "call_id", "name", "input" ], "title": "ThreadCustomToolCall", "type": "object" }, "ThreadFunctionCall": { "additionalProperties": false, "description": "A call on a tool the caller runs, with the response and the person that wrote it.", "properties": { "arguments": { "description": "the call's arguments, as emitted (JSON text)", "title": "Arguments", "type": "string" }, "call_id": { "description": "id correlating this call with its result", "title": "Call Id", "type": "string" }, "id": { "description": "the item's id", "title": "Id", "type": "string" }, "name": { "description": "the tool's name; inside its namespace, when it has one", "title": "Name", "type": "string" }, "namespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the `namespace` tools[] entry the called tool belongs to, so the caller routes the call to the tool it declared; null for a tool offered on its own", "title": "Namespace" }, "response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "id of the response whose turn wrote this item, which opens that answer's trace; null for an item a caller appended", "title": "Response Id" }, "status": { "const": "completed", "default": "completed", "description": "the item's completion status", "title": "Status", "type": "string" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "id of the person the request that wrote this item was for -- who wrote it, in a thread several people write in; null when that request named nobody, and on items written before authors were kept", "title": "Subject" }, "type": { "const": "function_call", "default": "function_call", "description": "output item kind", "title": "Type", "type": "string" } }, "required": [ "id", "call_id", "name", "arguments" ], "title": "ThreadFunctionCall", "type": "object" }, "ThreadItemHit": { "description": "One item a search found: where it is and the words around the match, never the whole\nitem, which is one `GET /threads/{thread_id}/items/{item_id}` away. Not `Read`,\nbecause a hit is no resource of its own: it points at an item and says why it matched.", "properties": { "created_at": { "description": "when it was written", "format": "date-time", "title": "Created At", "type": "string" }, "highlights": { "description": "the stretches of `snippet` that matched", "items": { "$ref": "#/components/schemas/SearchHighlight" }, "title": "Highlights", "type": "array" }, "item_id": { "description": "the item that matched", "title": "Item Id", "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "type": "object" }, { "type": "null" } ], "description": "the document that matched, when `metadata` was asked for", "title": "Metadata" }, "metadata_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "whose that document is; null for the organisation's own, or, for a subject token, for anyone else's", "title": "Metadata By" }, "rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "how closely the words matched (`ts_rank_cd`), higher is closer; null when only a document was asked for. Results are ordered newest first, not by this", "title": "Rank" }, "response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the response that wrote it, when one did", "title": "Response Id" }, "role": { "description": "who wrote it, as an item's read model names its author", "enum": [ "user", "assistant", "developer" ], "title": "Role", "type": "string" }, "snippet": { "description": "about thirty words of its text around what matched", "title": "Snippet", "type": "string" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the person its thread is for; a subject token sees its own id and null on every other thread", "title": "Subject" }, "thread_id": { "description": "the thread holding it", "title": "Thread Id", "type": "string" }, "type": { "description": "what kind of item it is", "enum": [ "message", "refusal" ], "title": "Type", "type": "string" } }, "required": [ "item_id", "thread_id", "response_id", "type", "role", "created_at", "snippet", "highlights", "rank", "subject" ], "title": "ThreadItemHit", "type": "object" }, "ThreadItemSearchPage": { "description": "One page of a search, newest first. A page reads a bounded batch of the history, so it may\nbe short or empty and still carry `next_cursor`. Not `Page[ThreadItemHit]`, because it also\nsays how far back it looked.", "properties": { "items": { "description": "the items found on this page, newest first", "items": { "$ref": "#/components/schemas/ThreadItemHit" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "pass as `cursor` to search further back; absent once the history is read. Sealed for this organisation: it names nothing a caller could read", "title": "Next Cursor" }, "searched_to": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "how far back this page looked, when it stopped before the start of the history: the instant of its last hit on a full page, and on a short one the day (UTC midnight) of the last item its batch read, which may be an item this request cannot read and so is named no closer than its day", "title": "Searched To" } }, "required": [ "items" ], "title": "ThreadItemSearchPage", "type": "object" }, "ThreadMessage": { "additionalProperties": false, "description": "A message of a thread, with the response and the person that wrote it.", "properties": { "content": { "description": "the message's content parts", "items": { "discriminator": { "mapping": { "input_file": "#/components/schemas/InputFileContent", "input_image": "#/components/schemas/InputImageContent", "input_text": "#/components/schemas/InputTextContent", "output_text": "#/components/schemas/OutputTextContent", "refusal": "#/components/schemas/RefusalContent" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/OutputTextContent" }, { "$ref": "#/components/schemas/InputTextContent" }, { "$ref": "#/components/schemas/RefusalContent" }, { "$ref": "#/components/schemas/InputImageContent" }, { "$ref": "#/components/schemas/InputFileContent" } ] }, "title": "Content", "type": "array" }, "id": { "description": "the item's id", "title": "Id", "type": "string" }, "response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "id of the response whose turn wrote this item, which opens that answer's trace; null for an item a caller appended", "title": "Response Id" }, "role": { "description": "who authored this message -- the Responses API's own set. Core's `delegate` tier renders as `user`, because a delegate speaks for a person and no vendor has a word for the tier itself; its `core` tier renders as nothing at all, because Core's own scaffolding is context Core added rather than an item a caller is shown. `system` is upstream's and is accepted back as input, but Core maps an incoming `system` message onto the developer tier, so nothing it answers ever says it", "enum": [ "assistant", "developer", "system", "user" ], "title": "Role", "type": "string" }, "status": { "default": "completed", "description": "the item's completion status: `incomplete` for a model's message whose text stops where its model call was cut -- a cancel, shutdown, the turn's deadline or a provider that failed partway -- and `completed` for every other", "enum": [ "completed", "incomplete" ], "title": "Status", "type": "string" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "id of the person the request that wrote this item was for -- who wrote it, in a thread several people write in; null when that request named nobody, and on items written before authors were kept", "title": "Subject" }, "type": { "const": "message", "default": "message", "description": "output item kind", "title": "Type", "type": "string" } }, "required": [ "id", "role", "content" ], "title": "ThreadMessage", "type": "object" }, "ThreadRead": { "description": "A thread's identity and metadata, as the threads API returns it.", "properties": { "created_at": { "description": "When this thread was created", "format": "date-time", "title": "Created At", "type": "string" }, "id": { "description": "Thread id", "title": "Id", "type": "string" }, "labels": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "the labels the rules over this row's kind read, as label -> a value or a list of values, read back exactly as written", "title": "Labels", "type": "object" }, "message_counts": { "$ref": "#/components/schemas/MessageCounts", "description": "the thread's `message` items by role, counted when the thread is read" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "caller-supplied key/value pairs, the application's own; for one release a rule over `thread` still reads a string here under a name `labels` lack", "title": "Metadata", "type": "object" }, "object": { "const": "thread", "default": "thread", "description": "The object's type", "title": "Object", "type": "string" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the person the thread is for; a subject token sees its own id and null on every other thread", "title": "Subject" }, "updated_at": { "description": "When this thread last gained an item", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "metadata", "labels", "subject", "message_counts", "created_at", "updated_at" ], "title": "ThreadRead", "type": "object" }, "ThreadReasoning": { "additionalProperties": false, "description": "A reasoning item of a thread, with the response and the person that wrote it.", "properties": { "id": { "description": "the item's id", "title": "Id", "type": "string" }, "response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "id of the response whose turn wrote this item, which opens that answer's trace; null for an item a caller appended", "title": "Response Id" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "id of the person the request that wrote this item was for -- who wrote it, in a thread several people write in; null when that request named nobody, and on items written before authors were kept", "title": "Subject" }, "summary": { "description": "the model's reasoning summary", "items": { "$ref": "#/components/schemas/SummaryText" }, "title": "Summary", "type": "array" }, "type": { "const": "reasoning", "default": "reasoning", "description": "output item kind", "title": "Type", "type": "string" } }, "required": [ "id", "summary" ], "title": "ThreadReasoning", "type": "object" }, "ThreadStateRead": { "description": "A thread's working state, as `/threads/{thread_id}/state` returns it\n(`docs/architecture/threads.md#working-state`).", "properties": { "carried_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The thread this state was copied from when this thread started, or null", "title": "Carried From" }, "object": { "const": "thread.state", "default": "thread.state", "description": "The object's type", "title": "Object", "type": "string" }, "sealed": { "description": "Whether `state` is withheld as `[sealed]`", "title": "Sealed", "type": "boolean" }, "state": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "string" } ], "description": "The working state, a JSON object; `{}` for a thread that has none yet, and the string `[sealed]` in its place when it was written while words a sealed publication withholds were in a turn's context -- a turn of the thread still reads it", "title": "State" }, "thread_id": { "description": "Thread the state belongs to", "title": "Thread Id", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the state was last written, or null when it never was", "title": "Updated At" }, "version": { "description": "The version of this state, `0` before its first write: what a write names in `If-Match` to be refused with 409 when another writer came first", "title": "Version", "type": "string" } }, "required": [ "thread_id", "state", "sealed", "version", "carried_from", "updated_at" ], "title": "ThreadStateRead", "type": "object" }, "ThreadSummaryRead": { "description": "One stored compaction summary of a thread, as the summaries route returns it.\n\nWhat a reader wants to know is which stretch of the conversation a model was handed in\nshortened form: the positions it covers, the tier it sits at, and the model that wrote it\n(`docs/architecture/threads.md` \"Compaction\"). The trust the summary inherited from the items\nunder it is *stored* -- it is what decides how a model is handed the summary -- and is no\npart of this read model, like every other trust label\n(`docs/architecture/decisions.md`).", "properties": { "created_at": { "description": "When this summary was written", "format": "date-time", "title": "Created At", "type": "string" }, "from_position": { "description": "First item position this summary covers", "title": "From Position", "type": "integer" }, "id": { "description": "Summary id", "title": "Id", "type": "string" }, "level": { "description": "0 for a summary of the thread's own items, 1 for a summary of level-0 summaries", "title": "Level", "type": "integer" }, "model": { "description": "Id of the model that wrote this summary", "title": "Model", "type": "string" }, "object": { "const": "thread.summary", "default": "thread.summary", "description": "The object's type", "title": "Object", "type": "string" }, "text": { "description": "The summary's text", "title": "Text", "type": "string" }, "through_position": { "description": "Last item position this summary covers", "title": "Through Position", "type": "integer" } }, "required": [ "id", "level", "from_position", "through_position", "model", "text", "created_at" ], "title": "ThreadSummaryRead", "type": "object" }, "ThreadUpdate": { "additionalProperties": false, "description": "Replaces a thread's metadata, its labels, or both, each entirely; a map left out is kept.", "properties": { "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "labels the rules over this row's kind read, as label -> a value or a list of 1 to 32 distinct values, each of 1 to 256 characters; at most 32 names. Held to the organisation's vocabulary and, for a request naming a person, to `writable_labels`; the thread's new labels, omitted keeps them", "title": "Labels" }, "metadata": { "anyOf": [ { "maxProperties": 16, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "maxLength": 512, "type": "string" } }, "type": "object" }, { "type": "null" } ], "description": "the thread's new key/value pairs; omitted keeps them", "title": "Metadata" } }, "title": "ThreadUpdate", "type": "object" }, "ThreadsConfig": { "additionalProperties": false, "description": "The `threads` capability: conversation storage. It carries nothing to configure.\n\nCompaction used to live here as `threads.compaction`; it is the `compaction` capability of\nits own now, with `threads` as its dependency (`control_0023` moved every stored config and\ntook the old key out of every key's row, so `extra=\"forbid\"` below is safe).", "properties": {}, "title": "ThreadsConfig", "type": "object" }, "TierLists": { "additionalProperties": false, "description": "One task type's lists, each ordered and drawn from the pool. `ack` takes `low` alone.", "properties": { "high": { "description": "The models a high turn of this task type tries", "items": { "maxLength": 200, "pattern": "^[A-Za-z0-9._:/-]{1,200}$", "type": "string" }, "title": "High", "type": "array" }, "low": { "description": "The models a low turn of this task type tries", "items": { "maxLength": 200, "pattern": "^[A-Za-z0-9._:/-]{1,200}$", "type": "string" }, "title": "Low", "type": "array" } }, "title": "TierLists", "type": "object" }, "ToolAliasCreate": { "additionalProperties": false, "description": "Body of `POST /tool-aliases`.", "properties": { "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this alias reads: a JSON Schema object with one property per variable, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; a `\"{@name}\"` fixed argument takes one and the model never sees it. Never a secret: an alias has no sealed store; omitted declares none" }, "description": { "description": "What the tool does in this context, as the model reads it", "maxLength": 1024, "minLength": 1, "title": "Description", "type": "string" }, "fixed_arguments": { "additionalProperties": true, "description": "Arguments merged over every call and hidden from the model's own schema. A fixed argument that is exactly `\"{$name}\"` is filled at each call with the install value of that name, and exactly `\"{@name}\"` with the call variable a request sent, typed as it is; a token inside other text, one nothing declares and a declaration no token uses are refused. A fixed argument that is exactly `{\"$prompt\": {\"id\": , \"version\": }}` is the stored prompt rendered at each call, as plain text, with the call variables a request sends for that prompt's variables: a prompt the writer cannot use, a version it does not have, an argument whose type is not a string and a sealed prompt are 422 on fixed_arguments, and a published alias version naming a prompt draft is 409. A fixed argument that is exactly `{\"$file\": {\"id\": \"src_...\"}}` hands the script the alias stands for that upload, copied when the alias version is written and filled at each call with the file's path on the computer: only a script target takes one, on a string argument, read as `GET /files/{id}/content` reads it, at most 8 per version, each and all together at most 20 MiB; anything else is 422 on fixed_arguments", "title": "Fixed Arguments", "type": "object" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/InstallValue" }, "description": "The values this alias's author sets, by name: `{type, value, allowed, description}` with `type` one of `string`, `number` and `enum`, never a secret. A `\"{$name}\"` fixed argument takes one; a marketplace install asks for each as a parameter; omitted declares none", "title": "Install Values", "type": "object" }, "labels": { "default": {}, "description": "The organisation's classification of this alias, as label -> value; what the rules over `tool` read. An alias carries its own, and its target is judged on the target's -- two names, two classifications, one invocation", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the alias, at most 16 KiB serialised: stored, returned and never read by Core; omitted or null stores {}", "title": "Metadata" }, "name": { "description": "Alias name, unique per tenant; the model sees `alias__`", "pattern": "^[a-z0-9_-]{1,48}$", "title": "Name", "type": "string" }, "target": { "description": "Qualified name of the tool this alias stands for, e.g. `builtin__generate_image__gpt-image-1` or an agent's `agent__`, over which the alias fixes no argument; an alias of an alias is refused", "maxLength": 64, "minLength": 1, "title": "Target", "type": "string" }, "target_version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "The version of the target every call runs, for a target whose source is versioned (an API, SQL or mail connector, a script, a function, an agent); null floats to the target's latest published version. A source with no versions and a number the target does not have are 422 on target_version, and a published alias version pinning a target draft is 409; omitted floats", "title": "Target Version" } }, "required": [ "name", "target", "description" ], "title": "ToolAliasCreate", "type": "object" }, "ToolAliasRead": { "description": "One tool alias as the API returns it.", "properties": { "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this alias reads: a JSON Schema object with one property per variable, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; a `\"{@name}\"` fixed argument takes one and the model never sees it. Never a secret: an alias has no sealed store. A sealed copy answers them too, because a caller must know what to send" }, "created_at": { "description": "When this alias was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created this alias", "title": "Created By", "type": "string" }, "description": { "description": "What the tool does in this context, as the model reads it", "title": "Description", "type": "string" }, "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "fixed_arguments": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Arguments merged over every call and hidden from the model's own schema; null for a sealed copy, whose publication withholds what it pins", "title": "Fixed Arguments" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "id": { "description": "Alias id", "title": "Id", "type": "string" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/InstallValue" }, "description": "The values this alias's author sets, by name: `{type, value, allowed, description}` with `type` one of `string`, `number` and `enum`, never a secret. A `\"{$name}\"` fixed argument takes one; a marketplace install asks for each as a parameter", "title": "Install Values", "type": "object" }, "labels": { "default": {}, "description": "The organisation's classification of this alias, as label -> value", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "latest_version": { "default": 1, "description": "The highest published version, which the target, description, fixed arguments and declarations are; 0 for an alias with only drafts, which only the management twin reads as its newest draft", "title": "Latest Version", "type": "integer" }, "metadata": { "additionalProperties": true, "default": {}, "description": "The opaque document attached to this alias; {} when none was set", "title": "Metadata", "type": "object" }, "name": { "description": "Alias name, unique per tenant", "title": "Name", "type": "string" }, "object": { "const": "tool_alias", "default": "tool_alias", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/OriginRead" }, { "type": "null" } ], "description": "The subscription that installed this alias, and the publication it came from; null for an alias this organisation registered itself" }, "qualified_name": { "description": "What the model calls it: `alias__`", "title": "Qualified Name", "type": "string" }, "resolved": { "description": "Whether the target is in this tenant's catalogue right now; false for an alias whose target has been deleted or has stopped being synced, which stays a row and is simply not offered", "title": "Resolved", "type": "boolean" }, "target": { "description": "Qualified name of the tool this alias stands for", "title": "Target", "type": "string" }, "target_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The version of the target every call runs, for a target whose source is versioned (an API, SQL or mail connector, a script, a function, an agent); null floats to the target's latest published version. A source with no versions and a number the target does not have are 422 on target_version, and a published alias version pinning a target draft is 409", "title": "Target Version" }, "updated_at": { "description": "When this alias was last updated", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "name", "qualified_name", "target", "description", "fixed_arguments", "install_values", "call_variables", "resolved", "created_by", "created_at", "updated_at" ], "title": "ToolAliasRead", "type": "object" }, "ToolAliasUpdate": { "additionalProperties": false, "description": "Body of `PATCH /tool-aliases/{alias_id}`; every field is optional and left alone when\nabsent. `name` never changes after creation.", "properties": { "call_variables": { "anyOf": [ { "$ref": "#/components/schemas/CallVariables" }, { "type": "null" } ], "description": "new call variables, replacing the stored declaration; omitted leaves it alone. The call variables this alias reads: a JSON Schema object with one property per variable, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; a `\"{@name}\"` fixed argument takes one and the model never sees it. Never a secret: an alias has no sealed store" }, "description": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "What the tool does in this context, as the model reads it", "title": "Description" }, "fixed_arguments": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Arguments merged over every call and hidden from the model's own schema. A fixed argument that is exactly `\"{$name}\"` is filled at each call with the install value of that name, and exactly `\"{@name}\"` with the call variable a request sent, typed as it is; a token inside other text, one nothing declares and a declaration no token uses are refused. A fixed argument that is exactly `{\"$prompt\": {\"id\": , \"version\": }}` is the stored prompt rendered at each call, as plain text, with the call variables a request sends for that prompt's variables: a prompt the writer cannot use, a version it does not have, an argument whose type is not a string and a sealed prompt are 422 on fixed_arguments, and a published alias version naming a prompt draft is 409. A fixed argument that is exactly `{\"$file\": {\"id\": \"src_...\"}}` hands the script the alias stands for that upload, copied when the alias version is written and filled at each call with the file's path on the computer: only a script target takes one, on a string argument, read as `GET /files/{id}/content` reads it, at most 8 per version, each and all together at most 20 MiB; anything else is 422 on fixed_arguments", "title": "Fixed Arguments" }, "install_values": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/InstallValue" }, "type": "object" }, { "type": "null" } ], "description": "new install values, replacing every stored one; omitted leaves them alone. The values this alias's author sets, by name: `{type, value, allowed, description}` with `type` one of `string`, `number` and `enum`, never a secret. A `\"{$name}\"` fixed argument takes one; a marketplace install asks for each as a parameter", "title": "Install Values" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "new classification of this alias, replacing whatever is stored; omitted leaves it alone, and an empty map clears it", "title": "Labels" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "new opaque document, replacing whatever is stored whole; omitted leaves it alone, and {} clears it", "title": "Metadata" }, "target": { "anyOf": [ { "maxLength": 64, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Qualified name of the tool this alias stands for; an agent's `agent__` fixes no argument, so fixed_arguments must then be empty", "title": "Target" }, "target_version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "The version of the target every call runs, for a target whose source is versioned (an API, SQL or mail connector, a script, a function, an agent); null floats to the target's latest published version. A source with no versions and a number the target does not have are 422 on target_version, and a published alias version pinning a target draft is 409; null unpins. Omitted leaves the pin alone, except on a write that changes `target`, which floats on the new target unless it names a version too", "title": "Target Version" } }, "title": "ToolAliasUpdate", "type": "object" }, "ToolAliasVersionRead": { "description": "One immutable version of an alias, as `GET /tool-aliases/{id}/versions[/{version}]`\nreturns it.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "alias_id": { "description": "Alias this version belongs to", "title": "Alias Id", "type": "string" }, "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this alias reads: a JSON Schema object with one property per variable, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A request sends their values in `tool_variables`; a `\"{@name}\"` fixed argument takes one and the model never sees it. Never a secret: an alias has no sealed store" }, "created_at": { "description": "When this version was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created this version", "title": "Created By", "type": "string" }, "description": { "description": "What the tool does in this context, as the model reads it", "title": "Description", "type": "string" }, "fixed_arguments": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Arguments merged over every call and hidden from the model's own schema; null for a sealed copy, whose publication withholds what it pins", "title": "Fixed Arguments" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/InstallValue" }, "description": "The values this alias's author sets, by name: `{type, value, allowed, description}` with `type` one of `string`, `number` and `enum`, never a secret. A `\"{$name}\"` fixed argument takes one; a marketplace install asks for each as a parameter", "title": "Install Values", "type": "object" }, "object": { "const": "tool_alias_version", "default": "tool_alias_version", "description": "The object's type", "title": "Object", "type": "string" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "state": { "default": "published", "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "target": { "description": "Qualified name of the tool this version stands for", "title": "Target", "type": "string" }, "target_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The version of the target every call runs, for a target whose source is versioned (an API, SQL or mail connector, a script, a function, an agent); null floats to the target's latest published version. A source with no versions and a number the target does not have are 422 on target_version, and a published alias version pinning a target draft is 409", "title": "Target Version" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" } }, "required": [ "alias_id", "version", "target", "description", "fixed_arguments", "install_values", "call_variables", "created_by", "acted_for", "created_at" ], "title": "ToolAliasVersionRead", "type": "object" }, "ToolApprovalOption": { "additionalProperties": false, "description": "The run parks the calls its modes say wait, until a person decides each.", "properties": { "default": { "default": "never", "description": "the mode of every tool no entry matches; `never` by default, so only what `tools` lists waits. `model` lets the model decide for every unlisted tool", "enum": [ "never", "model", "always" ], "title": "Default", "type": "string" }, "timeout_seconds": { "anyOf": [ { "maximum": 31536000.0, "minimum": 60.0, "type": "integer" }, { "type": "null" } ], "description": "how long one wait for a decision may last, in seconds, 60 to 31536000; past it the run fails with `approval_expired`. Null waits for as long as the run exists", "title": "Timeout Seconds" }, "tools": { "description": "at most 64 entries; a tool takes the mode of the entry naming it exactly, else the strictest among the globs matching it (`always` over `model` over `never`), else `default`. A name listed twice is refused, and so is an entry matching no tool the request offers", "items": { "$ref": "#/components/schemas/ApprovalEntry" }, "maxItems": 64, "title": "Tools", "type": "array" } }, "title": "ToolApprovalOption", "type": "object" }, "ToolBackground": { "additionalProperties": false, "description": "What a connector version or an MCP server registration says about tasks.", "properties": { "max_seconds": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "how long a task running this tool may take, in seconds; null uses the deployment's task_max_seconds, and a larger value is cut to it", "title": "Max Seconds" }, "mode": { "default": "never", "description": "`never` keeps every call synchronous; `allowed` lets the model start the tool in the background as well as call it; `always` makes a direct call start it in the background wherever the turn can hold a task. A connector or a server that logs in as the person a turn is for is never started in the background, whatever this says", "enum": [ "never", "allowed", "always" ], "title": "Mode", "type": "string" }, "retry_safe": { "default": false, "description": "whether the call may be sent again when the worker holding it stopped: true sends it again with the same Idempotency-Key; false ends the task as interrupted, because the call may or may not have completed", "title": "Retry Safe", "type": "boolean" } }, "title": "ToolBackground", "type": "object" }, "ToolBackgroundRead": { "additionalProperties": false, "description": "A tool's setting as the catalogue shows it: the setting that holds now, and where it is\nstored.", "properties": { "max_seconds": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "how long a task running this tool may take, in seconds; null uses the deployment's task_max_seconds, and a larger value is cut to it", "title": "Max Seconds" }, "mode": { "default": "never", "description": "`never` keeps every call synchronous; `allowed` lets the model start the tool in the background as well as call it; `always` makes a direct call start it in the background wherever the turn can hold a task. A connector or a server that logs in as the person a turn is for is never started in the background, whatever this says", "enum": [ "never", "allowed", "always" ], "title": "Mode", "type": "string" }, "reason": { "anyOf": [ { "const": "person_login", "type": "string" }, { "type": "null" } ], "description": "why `mode` is `never` whatever is stored: `person_login`, a credential that is a person's own login", "title": "Reason" }, "retry_safe": { "default": false, "description": "whether the call may be sent again when the worker holding it stopped: true sends it again with the same Idempotency-Key; false ends the task as interrupted, because the call may or may not have completed", "title": "Retry Safe", "type": "boolean" }, "stored_on": { "anyOf": [ { "enum": [ "agent_version", "connector_version", "script_version", "mcp_server", "organisation", "workflow" ], "type": "string" }, { "type": "null" } ], "description": "where this tool's setting is stored: `agent_version`, `connector_version`, `script_version`, `mcp_server`, `organisation` or `workflow`; null for a tool that cannot run in the background at all", "title": "Stored On" } }, "title": "ToolBackgroundRead", "type": "object" }, "ToolCallDecision": { "description": "One policy decision this call took, as its `policy.decision` audit row records it.", "properties": { "allowed": { "description": "Whether this decision admitted the call", "title": "Allowed", "type": "boolean" }, "axis": { "description": "What was decided: `tool_execution` for the rules over the tool itself, `data_egress` for a destination the tool would dial, and so on, as the audit row's `axis` says", "enum": [ "model_access", "tool_execution", "data_egress", "persistence", "resource_access", "subject_access" ], "title": "Axis", "type": "string" }, "reason": { "description": "The decision's fixed-wording reason, exactly as the audit row carries it", "title": "Reason", "type": "string" } }, "required": [ "axis", "allowed", "reason" ], "title": "ToolCallDecision", "type": "object" }, "ToolCallOutput": { "description": "One binary output the tool produced, carried inline or only noted.", "properties": { "data": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The output's bytes, base64-encoded; null when they are not carried -- the calling key has no `artifacts` capability, or the output (alone, or together with the ones before it) is larger than one artifact may be", "title": "Data" }, "index": { "description": "The output's position among the tool's outputs, from 0", "title": "Index", "type": "integer" }, "media_type": { "description": "The output's media type, as the tool declared it", "title": "Media Type", "type": "string" }, "size_bytes": { "description": "The output's size in bytes", "title": "Size Bytes", "type": "integer" } }, "required": [ "index", "media_type", "size_bytes", "data" ], "title": "ToolCallOutput", "type": "object" }, "ToolCallRead": { "description": "One tool execution a model call's answer asked for, as it comes back under that call.\n\nEverything the row holds and nothing a document does: the arguments the model wrote are in\nthis call's own document and the result is the next round's, so what a tree and a list need\nis here and what a reader opens one call for is not\n(`docs/architecture/tracing.md#a-tool-execution-is-a-record`).", "properties": { "answered_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The model call that received this result; null when the turn ended before another round was made", "title": "Answered To" }, "call_id": { "description": "The model's own id for this call, as it wrote it -- `toolu_...`, `call_...`", "title": "Call Id", "type": "string" }, "created_at": { "description": "When this record was written", "format": "date-time", "title": "Created At", "type": "string" }, "error_code": { "anyOf": [ { "enum": [ "vendor_error", "transport_error", "invalid_response", "invalid_arguments", "egress_refused", "denied_by_policy", "timeout", "executor_failed", "auth_failed", "unknown_tool", "max_uses_exceeded", "usage_cap_exceeded", "cost_limit", "call_depth_exceeded", "computer_busy", "trapped", "fuel_exhausted", "memory_exceeded", "conflict", "pseudonymisation_failed" ], "type": "string" }, { "type": "null" } ], "description": "Why it did not work, as a fixed code and never a vendor's own words; null when it worked", "title": "Error Code" }, "finished_at": { "description": "When the execution ended, however it ended", "format": "date-time", "title": "Finished At", "type": "string" }, "id": { "description": "Tool execution id", "title": "Id", "type": "string" }, "object": { "const": "tool_call", "default": "tool_call", "description": "The object's type", "title": "Object", "type": "string" }, "refs": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "What a router search ranked: `candidates`, the `hits` with their scores, and `keyword_only`; null for every other execution", "title": "Refs" }, "request_id": { "description": "Id of the request behind the turn that ran this tool", "title": "Request Id", "type": "string" }, "requested_by": { "description": "The model call whose answer asked for this execution -- after a fallover, the call that returned the round rather than the one that failed", "title": "Requested By", "type": "string" }, "response_id": { "description": "The response whose turn ran this tool", "title": "Response Id", "type": "string" }, "result_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "How large the result the model was given is, in UTF-8 bytes; null when the turn was cancelled before one was built", "title": "Result Bytes" }, "result_item_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The tool_result item this execution produced; null when the turn was cancelled before one was built", "title": "Result Item Id" }, "round": { "description": "Which round of the turn ran this tool, counted from zero", "title": "Round", "type": "integer" }, "routed": { "default": false, "description": "Whether the model reached this tool through the tool router; `tool_name` is the tool's own either way", "title": "Routed", "type": "boolean" }, "secret_variables": { "description": "Which of `variables` the tool declares secret (`x-secret`); names only, never a value", "items": { "type": "string" }, "title": "Secret Variables", "type": "array" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "What kind of thing ran it: system, http, mcp or core; null for a call that never resolved to a tool at all", "title": "Source" }, "span_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The `tool ` span opened for this execution, when telemetry was recording", "title": "Span Id" }, "started_at": { "description": "When Core began running this tool; equal to finished_at for a call Core refused before running anything", "format": "date-time", "title": "Started At", "type": "string" }, "status": { "description": "How the execution ended: ok, error, denied or cancelled", "enum": [ "ok", "error", "denied", "cancelled" ], "title": "Status", "type": "string" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this execution was made for, as the calling application named them; null for one made for nobody in particular", "title": "Subject" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The thread the turn behind this execution ran on; null when it ran on none", "title": "Thread Id" }, "tool_name": { "description": "The qualified tool name the model called, such as `builtin__web_search`", "title": "Tool Name", "type": "string" }, "trace_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Trace this execution happened in, when telemetry was recording", "title": "Trace Id" }, "variables": { "description": "The names of the call variables the tool was handed out of the request's `tool_variables`; never their values", "items": { "type": "string" }, "title": "Variables", "type": "array" }, "vendor_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The HTTP status the tool's own destination answered; null when there was no destination or it never answered", "title": "Vendor Status" } }, "required": [ "id", "response_id", "thread_id", "round", "call_id", "tool_name", "source", "requested_by", "answered_to", "status", "error_code", "vendor_status", "started_at", "finished_at", "result_bytes", "result_item_id", "request_id", "trace_id", "span_id", "created_at" ], "title": "ToolCallRead", "type": "object" }, "ToolCallRequest": { "additionalProperties": false, "description": "One call of one tool, named in the path, with the arguments a model would have sent.", "properties": { "arguments": { "additionalProperties": true, "description": "The call's arguments as a model would send them: one JSON object matching the tool's `parameters` schema", "title": "Arguments", "type": "object" }, "tool_variables": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Values for the call variables this tool declares, as a flat object of names to strings, numbers or booleans: checked against the tool's own declaration (422 on tool_variables.), never shown to a model; a name the tool does not declare is ignored", "propertyNames": { "maxLength": 64, "minLength": 1 }, "title": "Tool Variables", "type": "object" }, "version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "Pinned version of a versioned tool -- an `api__`, `mail__` or `sql__` connector's, a `script__` script's, a `function__` function's, an `agent__` agent's or an `alias__` alias's; its latest when unset. Naming it on any other tool is a 422, exactly as a request's `tools[]` answers it", "title": "Version" } }, "title": "ToolCallRequest", "type": "object" }, "ToolChoiceFunction": { "additionalProperties": false, "description": "`tool_choice` naming the one tool the model must call, in the Responses API's own shape.\n\nThe name is the one the model is offered the tool under -- a `function` tool's own name, or\nthe qualified name of a tool Core runs. It forces a tool the turn already offers and widens\nnothing: a name that is not among the tools this turn offers after policy is refused\n(`docs/architecture/responses.md` \"One call's knobs\").", "properties": { "name": { "description": "name of the one tool the model must call", "minLength": 1, "title": "Name", "type": "string" }, "type": { "const": "function", "description": "always `function`", "title": "Type", "type": "string" } }, "required": [ "type", "name" ], "title": "ToolChoiceFunction", "type": "object" }, "ToolChoiceIn": { "additionalProperties": false, "description": "How the model may use the offered tools.", "properties": { "disable_parallel_tool_use": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "`true` asks the model for at most one call a round. Refused with a 400 naming it on a model whose provider has no way to say so (Gemini)", "title": "Disable Parallel Tool Use" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the one tool the model must call, with `type: tool`. It must be a tool this turn offers after policy: naming it never makes a tool available", "title": "Name" }, "type": { "description": "the choice's kind", "enum": [ "auto", "any", "none", "tool" ], "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "ToolChoiceIn", "type": "object" }, "ToolOutputSubmission": { "additionalProperties": false, "description": "One pending client tool call's result, submitted to resume a suspended run.", "properties": { "call_id": { "description": "id of the pending tool_call this answers", "title": "Call Id", "type": "string" }, "output": { "anyOf": [ { "maxLength": 1048576, "type": "string" }, { "items": { "discriminator": { "mapping": { "input_image": "#/components/schemas/InputImagePart", "input_text": "#/components/schemas/InputTextPart" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/InputTextPart" }, { "$ref": "#/components/schemas/InputImagePart" } ] }, "type": "array" } ], "description": "the tool's output: its text, at most 1 MiB, or a list of `input_text` and `input_image` parts whose text, joined, is at most 1 MiB. An image is read by the model as the tool's data, never as the user's. A background run resolves no image, so one sent here is read by the model as `[image unavailable]`", "title": "Output" } }, "required": [ "call_id", "output" ], "title": "ToolOutputSubmission", "type": "object" }, "ToolRead": { "description": "One tool the tenant has, whatever its source. A read model over rows each source keeps;\nnothing is stored for the catalogue itself.", "properties": { "background": { "anyOf": [ { "$ref": "#/components/schemas/ToolBackgroundRead" }, { "type": "null" } ], "description": "Whether this tool may run in the background and where that is stored: the setting that holds now (`mode`, `max_seconds`, `retry_safe`), `stored_on` naming the version, registration or organisation row that keeps it, and `reason` when a person's own login makes it `never`. Null in a toolset's listing of its members, which does not read it" }, "capabilities": { "description": "Every capability a key needs effective to be offered this tool; empty when it is behind none", "items": { "enum": [ "threads", "compaction", "runs", "tooling", "artifacts", "files", "skills", "prompts", "knowledge", "memory", "pseudonymisation", "agents", "evaluations", "schedules", "management", "subjects", "datastores", "assist", "trust_envelope", "computer", "tasks", "improvements", "workflows", "product_events" ], "type": "string" }, "title": "Capabilities", "type": "array" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/CoverRead" }, { "type": "null" } ], "description": "The picture this organisation put on this tool, or null when neither it nor the server that offers it has one; `cover.from` says which of the two, and the image itself is read from that thing's own `.../cover` route" }, "description": { "description": "What the tool does, as the model sees it", "title": "Description", "type": "string" }, "labels": { "default": {}, "description": "The organisation's classification of this tool, as label -> value: its source's for a connector's or a server's operation, its own for an alias, and whatever `/labels` says for a tool with no row of its own", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "name": { "description": "Qualified name the model calls: `__`", "title": "Name", "type": "string" }, "object": { "const": "tool", "default": "tool", "description": "The object's type", "title": "Object", "type": "string" }, "parameters": { "additionalProperties": true, "description": "JSON Schema for the tool's arguments", "title": "Parameters", "type": "object" }, "source": { "description": "Where this tool comes from; `alias` is a tenant's own second name for a tool one of the other sources produces, and `agent` a stored agent run as one nested turn", "enum": [ "api", "mcp", "mail", "knowledge", "memory", "datastore", "script", "function", "sql", "builtin", "core", "alias", "agent" ], "title": "Source", "type": "string" }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the registration this tool belongs to -- the alias row's own id for an `alias` tool, the agent's for an `agent` tool; null for a builtin and for a `core` tool, neither of which has one", "title": "Source Id" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this tool's own registration last changed; null for a builtin and for a `core` tool", "title": "Updated At" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The version a call naming this tool without a `version` runs now: the latest published version of an `api__`, `mail__` or `sql__` connector, a `script__` script, a `function__` function, an `agent__` agent or an `alias__` alias (its own number, not its target's). Null for a tool that has no versions", "title": "Version" } }, "required": [ "name", "source", "source_id", "description", "parameters", "capabilities", "updated_at", "version" ], "title": "ToolRead", "type": "object" }, "ToolReferenceParam": { "additionalProperties": false, "description": "One tool of the tenant's catalogue, by its qualified name.\n\nThe one way a request names a tool Core runs, whatever its source (`api__lookup`,\n`mcp__vendor__search`, `knowledge__handbook`, `memory__idx_.._search`, `builtin__subagent`).\nThere is no per-request configuration of what a tool reaches: that is the registration's, and\nmoving it there is what made one reference shape possible at all (decision 3, 2026-09-15).", "properties": { "name": { "description": "the tool's qualified name, as `GET /tools` lists it", "maxLength": 64, "title": "Name", "type": "string" }, "type": { "const": "tool", "default": "tool", "description": "tool param kind", "title": "Type", "type": "string" }, "version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "pinned version of a versioned tool -- an `api__`, `mail__` or `sql__` connector's, a `script__` script's, a `function__` function's, an `agent__` agent's or an `alias__` alias's -- the alias's own version, whose target floats; its latest when unset. Naming it on any other tool is a 422", "title": "Version" } }, "required": [ "name" ], "title": "ToolReferenceParam", "type": "object" }, "ToolReport": { "additionalProperties": false, "description": "Which tools the bundle's aliases stand for that this organisation has not got.", "properties": { "unresolved": { "description": "Qualified tool names the bundle's aliases point at that this organisation's catalogue does not hold. Advice, not a refusal: the alias installs either way and reads `resolved: false` until the tool is registered. A target the bundle installs itself is never listed, and neither is a builtin or a core tool, which are the deployment's", "items": { "type": "string" }, "title": "Unresolved", "type": "array" } }, "title": "ToolReport", "type": "object" }, "ToolResultBlockIn": { "additionalProperties": false, "description": "A `tool_result` block: what the caller's own tool answered.", "properties": { "cache_control": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the vendor's prompt-cache hint; accepted and ignored: a hint that does not change what the answer means, so it is neither refused nor forwarded, stored or echoed", "title": "Cache Control" }, "content": { "anyOf": [ { "type": "string" }, { "items": { "discriminator": { "mapping": { "image": "#/components/schemas/ImageBlockIn", "text": "#/components/schemas/TextBlockIn" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/TextBlockIn" }, { "$ref": "#/components/schemas/ImageBlockIn" } ] }, "type": "array" } ], "default": "", "description": "the tool's output: text, or `text` and `image` blocks -- an image inline or by Core `file_id`, read by the model as the tool's data, never as the user's", "title": "Content" }, "is_error": { "default": false, "description": "whether the tool failed", "title": "Is Error", "type": "boolean" }, "tool_use_id": { "description": "id of the tool_use block this answers", "title": "Tool Use Id", "type": "string" }, "type": { "const": "tool_result", "default": "tool_result", "description": "content block kind", "title": "Type", "type": "string" } }, "required": [ "tool_use_id" ], "title": "ToolResultBlockIn", "type": "object" }, "ToolResultRead": { "additionalProperties": false, "description": "A tool call's result, as Core's own resources answer one.\n\nUpstream has no item for this at all -- a `function_call_output` is input-only there, and a\nround Core ran itself is an `mcp_call` -- so this is the shape that carries what the vendor's\nsurface has nowhere to put: the `citations` the producing tool wrote down, and the\n`artifacts` the call left behind. Who produced the result is not on it: a result Core\nauthored itself is a failure and says so in `error`, which is the same thing `McpCallOutput`\ndoes with the same four fixed sentences.", "properties": { "artifacts": { "default": [], "description": "ids of the artifacts this result produced, in the order the tool wrote them; empty for a tool that produced none (`docs/architecture/files-and-artifacts.md`)", "items": { "type": "string" }, "title": "Artifacts", "type": "array" }, "call_id": { "description": "id correlating this result with its call", "title": "Call Id", "type": "string" }, "citations": { "default": [], "description": "the sources this result's text came from, in the order the tool that produced it wrote them; empty for a tool that reads no sources (`docs/architecture/responses.md#citations`)", "items": { "$ref": "#/components/schemas/CitationRead" }, "title": "Citations", "type": "array" }, "error": { "anyOf": [ { "$ref": "#/components/schemas/McpToolExecutionError" }, { "type": "null" } ], "description": "why the call produced no output, when it produced none" }, "id": { "description": "the item's id", "title": "Id", "type": "string" }, "name": { "description": "the tool's name", "title": "Name", "type": "string" }, "output": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the tool's output text; null when the call failed", "title": "Output" }, "response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "id of the response whose turn wrote this item, which opens that answer's trace; null for an item a caller appended", "title": "Response Id" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "id of the person the request that wrote this item was for -- who wrote it, in a thread several people write in; null when that request named nobody, and on items written before authors were kept", "title": "Subject" }, "type": { "const": "function_call_output", "default": "function_call_output", "description": "output item kind", "title": "Type", "type": "string" } }, "required": [ "id", "call_id", "name" ], "title": "ToolResultRead", "type": "object" }, "ToolSearch": { "additionalProperties": false, "description": "Body of `POST /tools/search`.", "properties": { "limit": { "default": 10, "description": "Most tools returned", "maximum": 50.0, "minimum": 1.0, "title": "Limit", "type": "integer" }, "query": { "description": "What the tool should do, in plain words", "maxLength": 512, "minLength": 1, "title": "Query", "type": "string" } }, "required": [ "query" ], "title": "ToolSearch", "type": "object" }, "ToolSearchConfig": { "additionalProperties": false, "description": "`tooling.tool_search`: whether this key's turns may route their tools through a search,\nand what a turn that names no mode does.", "properties": { "budget_tokens": { "default": 4000, "description": "the most one search result may weigh, counted at four characters per token", "maximum": 32000, "minimum": 100, "title": "Budget Tokens", "type": "integer" }, "default_mode": { "default": "direct", "description": "the mode a turn runs in when neither the request nor its agent names one; `router` needs `enabled`", "enum": [ "direct", "router" ], "title": "Default Mode", "type": "string" }, "enabled": { "default": false, "description": "whether this key's turns may put their tools behind the router; effective only where the organisation and every one above it permit tool search", "title": "Enabled", "type": "boolean" }, "preload": { "$ref": "#/components/schemas/ToolSearchPreloadConfig", "description": "the tools picked for a turn when it starts, rather than found by the model" }, "top_k": { "default": 5, "description": "how many tools one search returns at most", "maximum": 20, "minimum": 1, "title": "Top K", "type": "integer" } }, "title": "ToolSearchConfig", "type": "object" }, "ToolSearchHit": { "description": "One tool a search found, and how well it matched.", "properties": { "score": { "description": "Reciprocal rank fusion of where the tool ranked by meaning and by keyword; only the order is meaningful, never the number across searches", "title": "Score", "type": "number" }, "tool": { "$ref": "#/components/schemas/ToolRead", "description": "The tool, exactly as the catalogue lists it" } }, "required": [ "tool", "score" ], "title": "ToolSearchHit", "type": "object" }, "ToolSearchParam": { "additionalProperties": false, "description": "`tool_search` on a request or an agent version: whether the turn's server tools are offered\ndirectly or behind the router, and what a search may answer\n(`docs/architecture/tooling.md#tool-router-switch`). A request's choice wins over its agent's,\nand either over the key's `tooling.tool_search.default_mode`.", "properties": { "budget_tokens": { "anyOf": [ { "maximum": 32000.0, "minimum": 100.0, "type": "integer" }, { "type": "null" } ], "description": "the most one search result may weigh, at four characters per token; null takes the key's", "title": "Budget Tokens" }, "mode": { "description": "`direct` offers every tool in the tool list; `router` offers two tools that find and run the rest, and needs the key's `tooling.tool_search.enabled`", "enum": [ "direct", "router" ], "title": "Mode", "type": "string" }, "top_k": { "anyOf": [ { "maximum": 20.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "how many tools one search returns at most; null takes the key's", "title": "Top K" } }, "required": [ "mode" ], "title": "ToolSearchParam", "type": "object" }, "ToolSearchPreloadConfig": { "additionalProperties": false, "description": "`tooling.tool_search.preload`: whether a turn in `router` mode is handed its likely tools\nas a search result when it starts, and how many at most and at what weight, in the shape\n`MemoryInjectionConfig` gives memory (`docs/architecture/tooling.md#tool-router-preload`).", "properties": { "budget_tokens": { "default": 1500, "description": "most tokens the preloaded result may cost, counted as four characters per token over the definitions it holds; the deployment's turn ceiling can only lower it", "maximum": 8000, "minimum": 100, "title": "Budget Tokens", "type": "integer" }, "enabled": { "default": false, "description": "whether a turn in router mode starts with the tools likeliest for its message already found, as a search result after the thread's history", "title": "Enabled", "type": "boolean" }, "limit": { "default": 5, "description": "most tools one turn is handed at its start", "maximum": 20, "minimum": 1, "title": "Limit", "type": "integer" } }, "title": "ToolSearchPreloadConfig", "type": "object" }, "ToolSearchRead": { "description": "The catalogue ranked against one query, best first. Not paged: a search answers its\n`limit` and no cursor.", "properties": { "considered": { "description": "How many of the tools this caller may list were ranked: every one up to 2,048, and past that the 2,048 whose words match the query best", "title": "Considered", "type": "integer" }, "items": { "description": "The tools found, best first", "items": { "$ref": "#/components/schemas/ToolSearchHit" }, "title": "Items", "type": "array" }, "ranked_by": { "description": "`meaning_and_keyword` when the query was embedded, `keyword` when this organisation has no embedding model it may use and the ranking is by words alone", "enum": [ "meaning_and_keyword", "keyword" ], "title": "Ranked By", "type": "string" } }, "required": [ "items", "ranked_by", "considered" ], "title": "ToolSearchRead", "type": "object" }, "ToolSearchToolIn": { "additionalProperties": false, "description": "Anthropic's tool search server tool, BM25 or regex, answered by Core's own tool router: the\nentry puts the whole call behind the router, as `tool_search` `router` would, and is then no\ntool of its own. The model is offered Core's `builtin__tool_search` and `builtin__tool_run`,\nand their rounds come back as `mcp_tool_use` / `mcp_tool_result`, never as the vendor's\n`server_tool_use` (`docs/architecture/messages.md`). Core's own `tool_search` wins over it.", "properties": { "allowed_callers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "who may call the tool; refused unless it names `direct`, the only caller Core has", "title": "Allowed Callers" }, "cache_control": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the vendor's prompt-cache hint; accepted and ignored: a hint that does not change what the answer means, so it is neither refused nor forwarded, stored or echoed", "title": "Cache Control" }, "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "deferring the search tool itself; accepted and ignored: a hint that does not change what the answer means, so it is neither refused nor forwarded, stored or echoed", "title": "Defer Loading" }, "name": { "description": "the variant's own name", "enum": [ "tool_search_tool_bm25", "tool_search_tool_regex" ], "title": "Name", "type": "string" }, "strict": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "schema strictness; accepted and ignored: a hint that does not change what the answer means, so it is neither refused nor forwarded, stored or echoed", "title": "Strict" }, "type": { "description": "tool kind: the vendor's tool search, either variant, any spelling", "enum": [ "tool_search_tool_bm25_20251119", "tool_search_tool_bm25", "tool_search_tool_regex_20251119", "tool_search_tool_regex" ], "title": "Type", "type": "string" } }, "required": [ "type", "name" ], "title": "ToolSearchToolIn", "type": "object" }, "ToolUseBlock": { "additionalProperties": false, "description": "A call the model made to a tool **the caller** executes.", "properties": { "id": { "description": "id correlating this call with the tool_result that answers it", "title": "Id", "type": "string" }, "input": { "additionalProperties": true, "description": "the call's arguments", "title": "Input", "type": "object" }, "name": { "description": "the tool the model called", "title": "Name", "type": "string" }, "type": { "const": "tool_use", "default": "tool_use", "description": "content block kind", "title": "Type", "type": "string" } }, "required": [ "id", "name", "input" ], "title": "ToolUseBlock", "type": "object" }, "ToolUseBlockIn": { "additionalProperties": false, "description": "A `tool_use` block replayed on the request: the model's own prior call.\n\nEvery field the vendor's own `ToolUseBlock` declares is declared here, because that is what\nan SDK sends back when a caller hands `response.content` to the next request -- it\nserialises its whole model, nulls included (`anthropic` 1.7.0). `extra=\"forbid\"` stays: a\nfield no vendor declares is still a 400 naming it.", "properties": { "cache_control": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the vendor's prompt-cache hint; accepted and ignored: a hint that does not change what the answer means, so it is neither refused nor forwarded, stored or echoed", "title": "Cache Control" }, "caller": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the vendor's record of which side made this call; accepted and ignored. A replayed block describes a round that already happened rather than asking for behaviour, and Core reads the call itself", "title": "Caller" }, "id": { "description": "the call's id", "maxLength": 128, "minLength": 1, "title": "Id", "type": "string" }, "input": { "additionalProperties": true, "default": {}, "description": "the call's arguments", "title": "Input", "type": "object" }, "name": { "description": "the tool that was called", "title": "Name", "type": "string" }, "toolset_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the toolset family the vendor's own SDK writes on a replayed call; accepted and ignored for the same reason as `caller`", "title": "Toolset Name" }, "type": { "const": "tool_use", "default": "tool_use", "description": "content block kind", "title": "Type", "type": "string" } }, "required": [ "id", "name" ], "title": "ToolUseBlockIn", "type": "object" }, "ToolingConfig": { "additionalProperties": false, "description": "The `tooling` capability: system-provided tools available to a run, and whether a run may\nreach its tools through the router.", "properties": { "system_tools": { "default": [], "description": "system tools this key may invoke", "items": { "enum": [ "subagent", "web_fetch", "web_search", "generate_image", "platform_logs", "platform_trace", "platform_alerts", "read_document", "computer", "create_artifact", "transcribe_audio", "speak", "decide", "list_files", "move_file", "rename_file", "delete_file" ], "type": "string" }, "title": "System Tools", "type": "array" }, "tool_search": { "$ref": "#/components/schemas/ToolSearchConfig", "description": "the tool router: whether this key's turns may use it, and its defaults" } }, "title": "ToolingConfig", "type": "object" }, "ToolsMissing": { "additionalProperties": false, "description": "The tools an `mcp_server` parameter asks for that the server bound to it does not offer.", "properties": { "parameter": { "description": "The mcp_server parameter", "title": "Parameter", "type": "string" }, "tools": { "description": "The tools the parameter declares that the bound server's last sync did not find", "items": { "type": "string" }, "title": "Tools", "type": "array" } }, "required": [ "parameter" ], "title": "ToolsMissing", "type": "object" }, "ToolsetCreate": { "additionalProperties": false, "description": "Body of `POST /toolsets`.", "properties": { "description": { "default": "", "description": "What this group of tools is for", "maxLength": 1024, "title": "Description", "type": "string" }, "labels": { "default": {}, "description": "The organisation's classification of this toolset, as label -> value; what the rules over `tool` read", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "An opaque document a caller attaches to the toolset, at most 16 KiB serialised: stored, returned and never read by Core; omitted or null stores {}", "title": "Metadata" }, "name": { "description": "Toolset name, unique per tenant", "pattern": "^[a-z0-9_-]{1,48}$", "title": "Name", "type": "string" }, "tools": { "description": "fnmatch globs over qualified tool names, e.g. `mcp__vendor__*`", "items": { "pattern": "^[A-Za-z0-9_.*?\\[\\]-]{1,64}$", "type": "string" }, "maxItems": 64, "title": "Tools", "type": "array" } }, "required": [ "name" ], "title": "ToolsetCreate", "type": "object" }, "ToolsetRead": { "description": "A toolset, stored or implicit, as the API returns it.", "properties": { "cover": { "anyOf": [ { "$ref": "#/components/schemas/CoverRead" }, { "type": "null" } ], "description": "The picture this organisation put on this toolset, which for an implicit one is the registration's own; null when it has none, and the image itself is read from its own `.../cover` route" }, "created_at": { "description": "When this toolset was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created this toolset", "title": "Created By", "type": "string" }, "description": { "description": "What this group of tools is for", "title": "Description", "type": "string" }, "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "id": { "description": "Toolset id; an MCP server's own id for an implicit toolset", "title": "Id", "type": "string" }, "implicit": { "description": "True for the toolset every registered MCP server is by construction; implicit toolsets cannot be edited or deleted here", "title": "Implicit", "type": "boolean" }, "labels": { "default": {}, "description": "The organisation's classification of this toolset, as label -> value", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "latest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest published version, which `description` and `tools` are; 0 for a toolset with only drafts, which only the management twin reads as its newest draft; null for an implicit toolset, which has no versions", "title": "Latest Version" }, "metadata": { "additionalProperties": true, "default": {}, "description": "The opaque document attached to this toolset; {} when none was set; for an implicit toolset, the registration's own", "title": "Metadata", "type": "object" }, "name": { "description": "Toolset name, unique per tenant", "title": "Name", "type": "string" }, "object": { "const": "toolset", "default": "toolset", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/OriginRead" }, { "type": "null" } ], "description": "The subscription that installed this toolset, and the publication it came from; null for a toolset this organisation composed itself, and for an implicit one" }, "tools": { "description": "fnmatch globs over qualified tool names; empty when the publication that shared this toolset sealed it, and a turn expanding it still matches them all", "items": { "type": "string" }, "title": "Tools", "type": "array" }, "updated_at": { "description": "When this toolset was last updated", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "name", "description", "tools", "implicit", "created_by", "created_at", "updated_at" ], "title": "ToolsetRead", "type": "object" }, "ToolsetToolParam": { "additionalProperties": false, "description": "One of the tenant's toolsets, by name: every tool its globs currently match.\n\nA toolset that matches nothing is not an error -- a group is a standing statement about which\ntools belong together, and an empty one is a true answer about a tenant that has not\nregistered them yet.", "properties": { "name": { "description": "the toolset's name, stored or an MCP server's own", "maxLength": 64, "title": "Name", "type": "string" }, "type": { "const": "toolset", "default": "toolset", "description": "tool param kind", "title": "Type", "type": "string" } }, "required": [ "name" ], "title": "ToolsetToolParam", "type": "object" }, "ToolsetUpdate": { "additionalProperties": false, "description": "Body of `PATCH /toolsets/{toolset_id}`; every field is optional and left alone when\nabsent. `name` never changes after creation: a request names a toolset by it.", "properties": { "description": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "What this group of tools is for", "title": "Description" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "new classification of this toolset, replacing whatever is stored; omitted leaves it alone, and an empty map clears it", "title": "Labels" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "new opaque document, replacing whatever is stored whole; omitted leaves it alone, and {} clears it", "title": "Metadata" }, "tools": { "anyOf": [ { "items": { "pattern": "^[A-Za-z0-9_.*?\\[\\]-]{1,64}$", "type": "string" }, "maxItems": 64, "type": "array" }, { "type": "null" } ], "description": "fnmatch globs over qualified tool names", "title": "Tools" } }, "title": "ToolsetUpdate", "type": "object" }, "ToolsetVersionRead": { "description": "One immutable version of a toolset, as `GET /toolsets/{id}/versions[/{version}]` returns\nit.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "created_at": { "description": "When this version was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created this version", "title": "Created By", "type": "string" }, "description": { "description": "What this group of tools is for", "title": "Description", "type": "string" }, "object": { "const": "toolset_version", "default": "toolset_version", "description": "The object's type", "title": "Object", "type": "string" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "state": { "default": "published", "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "tools": { "description": "fnmatch globs over qualified tool names; empty when the publication that shared this toolset sealed it", "items": { "type": "string" }, "title": "Tools", "type": "array" }, "toolset_id": { "description": "Toolset this version belongs to", "title": "Toolset Id", "type": "string" }, "version": { "description": "Version number, starting at 1", "title": "Version", "type": "integer" } }, "required": [ "toolset_id", "version", "description", "tools", "created_by", "acted_for", "created_at" ], "title": "ToolsetVersionRead", "type": "object" }, "TraceDocument": { "description": "One call, whole: what went, what came back, and what Core made of it.", "properties": { "format": { "default": 1, "description": "the document shape's own version", "title": "Format", "type": "integer" }, "interpretation": { "$ref": "#/components/schemas/Interpretation", "description": "Core's reading of the same call" }, "request": { "$ref": "#/components/schemas/TracedRequest", "description": "what the vendor received" }, "response": { "$ref": "#/components/schemas/TracedResponse", "description": "what the vendor answered" }, "sealed_withheld": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "description": "true when the words a sealed publication gave this call -- an instruction, a rendered prompt, a skill body, a summary made from them -- were replaced by `[sealed]` as the document was recorded; null for a document recorded before this was, whose sealed words every reader replaces by the rows its elements name before answering it", "title": "Sealed Withheld" } }, "title": "TraceDocument", "type": "object" }, "TraceEntry": { "description": "One node's execution record, in run order.", "properties": { "annotations": { "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "boolean" } ] }, "description": "fields the node attached via `PipelineContext.annotate` (e.g. skipped_keys)", "title": "Annotations", "type": "object" }, "in_count": { "description": "items in its input (its own count for a sized non-list payload, else 1)", "title": "In Count", "type": "integer" }, "ms": { "description": "how long the call took", "title": "Ms", "type": "number" }, "node_id": { "description": "the node that ran", "title": "Node Id", "type": "string" }, "out_count": { "description": "items in its output (its own count for a sized non-list payload, else 1)", "title": "Out Count", "type": "integer" }, "type": { "description": "its component type", "title": "Type", "type": "string" } }, "required": [ "node_id", "type", "ms", "in_count", "out_count" ], "title": "TraceEntry", "type": "object" }, "TracedRequest": { "description": "What went to the vendor, in the vendor's own shape.", "properties": { "body": { "description": "the request body the vendor received -- parsed JSON where it was JSON, the text otherwise, or the client's own prepared payload for a provider whose bytes Core cannot observe", "title": "Body" }, "headers_omitted": { "const": true, "default": true, "description": "always true: no request header is ever recorded, because that is where every credential lives", "title": "Headers Omitted", "type": "boolean" }, "media_type": { "default": "application/json", "description": "content type of the recorded body", "title": "Media Type", "type": "string" }, "observed": { "default": true, "description": "whether this body is the bytes seen on the wire (true) or the client's own prepared payload for a provider that takes no transport Core can observe (false)", "title": "Observed", "type": "boolean" } }, "title": "TracedRequest", "type": "object" }, "TracedResponse": { "description": "What came back, raw.", "properties": { "body": { "description": "the vendor's final body, whole. Null for a streamed answer, which is recorded as its `chunks` and nothing else -- the assembly of an event stream is the vendor's protocol rather than its answer -- and null for a call that never got one", "title": "Body" }, "chunks": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "the ordered chunks of a streamed answer, exactly as they arrived, and the only record a streamed call has of what came back; null for a call that was not streamed. Cut from the end when the document hits its cap, so a truncated stream still holds what the model said first, and empty when not even one chunk fitted", "title": "Chunks" }, "error": { "description": "the vendor's own error body, under the fixed-vendor allow-list where one exists; null when the call did not fail or the vendor said nothing readable", "title": "Error" }, "raw": { "default": true, "description": "whether this is the vendor's own answer (true) or Core's mapping of it, for a provider whose SDK exposes no raw response (false)", "title": "Raw", "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "the vendor's HTTP status, when Core saw the wire; null for a provider whose client Core reads through an SDK object instead", "title": "Status" } }, "title": "TracedResponse", "type": "object" }, "TranscriptionJobCreate": { "additionalProperties": false, "description": "`POST /audio/transcription-jobs`: one uploaded recording and the model to transcribe it.", "properties": { "file_id": { "description": "id of the uploaded file holding the recording", "maxLength": 200, "minLength": 1, "title": "File Id", "type": "string" }, "language": { "anyOf": [ { "pattern": "^[a-z]{2,3}$", "type": "string" }, { "type": "null" } ], "description": "the recording's language as an ISO 639-1 code ('nl'); left out, the model detects it in every chunk", "title": "Language" }, "model": { "description": "catalogue id of an audio model", "maxLength": 200, "minLength": 1, "title": "Model", "type": "string" }, "prompt": { "anyOf": [ { "maxLength": 4000, "type": "string" }, { "type": "null" } ], "description": "text that guides the model -- names, spellings, style -- sent with every chunk", "title": "Prompt" }, "temperature": { "anyOf": [ { "maximum": 1.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "sampling temperature, 0 to 1", "title": "Temperature" } }, "required": [ "file_id", "model" ], "title": "TranscriptionJobCreate", "type": "object" }, "TranscriptionJobError": { "description": "Why a job failed: a fixed code and a fixed sentence, never a vendor's words.", "properties": { "code": { "description": "key_revoked, tenant_unavailable, key_disabled, service_account_paused, model_not_available, model_not_allowed, file_unavailable, recording_unreadable, split_timeout, transcription_refused, transcription_failed, usage_cap_exceeded, recording_too_long or reaped_too_often", "title": "Code", "type": "string" }, "message": { "description": "what the code means, in one fixed sentence", "title": "Message", "type": "string" } }, "required": [ "code", "message" ], "title": "TranscriptionJobError", "type": "object" }, "TranscriptionJobRead": { "description": "One transcription job: what it was asked for, where it stands and, once completed, its\ntranscript.", "properties": { "chunks_done": { "description": "chunks transcribed and kept so far", "title": "Chunks Done", "type": "integer" }, "chunks_total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "chunks the recording is planned to take; null until the worker has read its length, exact once the job completes", "title": "Chunks Total" }, "created_at": { "description": "when the job was created", "format": "date-time", "title": "Created At", "type": "string" }, "ended_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "when the job completed, failed or was cancelled; null while it runs", "title": "Ended At" }, "error": { "anyOf": [ { "$ref": "#/components/schemas/TranscriptionJobError" }, { "type": "null" } ], "description": "why the job failed; null otherwise" }, "file_id": { "description": "the file holding the recording", "title": "File Id", "type": "string" }, "id": { "description": "the job's id", "title": "Id", "type": "string" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the language the job was given, or null", "title": "Language" }, "model": { "description": "the audio model transcribing it", "title": "Model", "type": "string" }, "result": { "anyOf": [ { "$ref": "#/components/schemas/TranscriptionJobResult" }, { "type": "null" } ], "description": "the transcript, once the job completed; null otherwise" }, "status": { "description": "queued, in_progress, completed, failed or cancelled", "enum": [ "queued", "in_progress", "completed", "failed", "cancelled" ], "title": "Status", "type": "string" } }, "required": [ "id", "status", "file_id", "model", "language", "chunks_done", "chunks_total", "error", "result", "created_at", "ended_at" ], "title": "TranscriptionJobRead", "type": "object" }, "TranscriptionJobResult": { "description": "A completed job's transcript, in `verbose_json`'s shape with one segment per chunk.", "properties": { "duration": { "description": "the seconds of the recording the chunks cover", "title": "Duration", "type": "number" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the language the job named; null when it named none", "title": "Language" }, "segments": { "description": "one segment per chunk, in order", "items": { "$ref": "#/components/schemas/TranscriptionSegmentRead" }, "title": "Segments", "type": "array" }, "task": { "const": "transcribe", "default": "transcribe", "description": "always transcribe; translation is not offered", "title": "Task", "type": "string" }, "text": { "description": "every chunk's text, in order, joined by one space", "title": "Text", "type": "string" }, "usage": { "description": "what every chunk billed together: seconds, or tokens for a model billed in tokens", "discriminator": { "mapping": { "duration": "#/components/schemas/TranscriptionUsageRead", "tokens": "#/components/schemas/TranscriptionTokenUsageRead" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/TranscriptionUsageRead" }, { "$ref": "#/components/schemas/TranscriptionTokenUsageRead" } ], "title": "Usage" } }, "required": [ "language", "duration", "text", "segments", "usage" ], "title": "TranscriptionJobResult", "type": "object" }, "TranscriptionRead": { "description": "`response_format=json`, the default: the text and what it cost.", "properties": { "text": { "description": "what the model heard", "title": "Text", "type": "string" }, "usage": { "description": "the seconds or tokens this transcription billed", "discriminator": { "mapping": { "duration": "#/components/schemas/TranscriptionUsageRead", "tokens": "#/components/schemas/TranscriptionTokenUsageRead" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/TranscriptionUsageRead" }, { "$ref": "#/components/schemas/TranscriptionTokenUsageRead" } ], "title": "Usage" } }, "required": [ "text", "usage" ], "title": "TranscriptionRead", "type": "object" }, "TranscriptionSegmentRead": { "description": "One chunk of the recording and what was heard in it.", "properties": { "end": { "description": "where the chunk ends, in seconds of the recording", "title": "End", "type": "number" }, "start": { "description": "where the chunk starts, in seconds of the recording", "title": "Start", "type": "number" }, "text": { "description": "what the model heard in this chunk", "title": "Text", "type": "string" } }, "required": [ "start", "end", "text" ], "title": "TranscriptionSegmentRead", "type": "object" }, "TranscriptionTokenUsageRead": { "description": "What the transcription was billed, in OpenAI's token shape, for a model its vendor bills\nin tokens (`gpt-4o-transcribe`).", "properties": { "input_tokens": { "description": "the input tokens the vendor billed, the recording's and the prompt's alike", "title": "Input Tokens", "type": "integer" }, "output_tokens": { "description": "the output tokens the vendor billed", "title": "Output Tokens", "type": "integer" }, "total_tokens": { "description": "input_tokens plus output_tokens", "title": "Total Tokens", "type": "integer" }, "type": { "const": "tokens", "default": "tokens", "description": "tokens: this model is billed by the tokens it read and wrote", "title": "Type", "type": "string" } }, "required": [ "input_tokens", "output_tokens", "total_tokens" ], "title": "TranscriptionTokenUsageRead", "type": "object" }, "TranscriptionUsageRead": { "description": "What the transcription was billed, in OpenAI's duration shape.", "properties": { "seconds": { "description": "the whole seconds of audio this transcription was billed, the vendor's duration rounded up -- the quantity of its audio_transcription usage row", "title": "Seconds", "type": "integer" }, "type": { "const": "duration", "default": "duration", "description": "duration: this model is billed by the seconds of audio", "title": "Type", "type": "string" } }, "required": [ "seconds" ], "title": "TranscriptionUsageRead", "type": "object" }, "TranscriptionVerboseRead": { "description": "`response_format=verbose_json`: the text with its language and duration. No `segments`\nor `words`: the vendors Core speaks to answer neither in the format it asks them for.", "properties": { "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "the seconds of audio the vendor reported; null for a model billed in tokens, which reports none", "title": "Duration" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the language the request named; null when it named none, since the vendor's json answer does not say what it detected", "title": "Language" }, "task": { "const": "transcribe", "default": "transcribe", "description": "always transcribe; translation is not offered", "title": "Task", "type": "string" }, "text": { "description": "what the model heard", "title": "Text", "type": "string" }, "usage": { "description": "the seconds or tokens this transcription billed", "discriminator": { "mapping": { "duration": "#/components/schemas/TranscriptionUsageRead", "tokens": "#/components/schemas/TranscriptionTokenUsageRead" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/TranscriptionUsageRead" }, { "$ref": "#/components/schemas/TranscriptionTokenUsageRead" } ], "title": "Usage" } }, "required": [ "language", "duration", "text", "usage" ], "title": "TranscriptionVerboseRead", "type": "object" }, "TrustEnvelopeConfig": { "additionalProperties": false, "description": "The `trust_envelope` capability: whether a turn's context tells the model which of its text\nis data (`docs/architecture/responses.md` \"Context assembly and trust\").\n\nEffective, every context this key's turns assemble opens with Core's preamble and carries\nevery piece of untrusted text -- the user's message, a tool result, a retrieved or remembered\nblock, a prompt variable -- inside an `` envelope. Not effective, there is no\npreamble and no envelope anywhere in that context: the same text reaches the model as plain\ncontent in the message slot it already had.\n\nNo configuration, and that is the decision rather than an omission (the user, 2026-10-01): it\nis all of it or none of it, because a context that envelopes a tool result under a preamble\nwhile leaving the user's message bare -- or the reverse -- tells the model something about\nthe bare text that Core never decided. No dependency either: a stateless turn has a context\ntoo.\n\nWhat it does not switch is anything Core enforces outside the model. The trust label on every\nitem, the authority order, the hoisting of trusted instructions, tool policy, egress and a\nsubject's rules are the same either way; only what the model is *told* changes\n(`app.turns.engine`, the one place that reads this).", "properties": {}, "title": "TrustEnvelopeConfig", "type": "object" }, "UploadPartRead": { "description": "One part Core has received.", "properties": { "part_number": { "description": "The part's number, from 1", "title": "Part Number", "type": "integer" }, "received_at": { "description": "When the part was last received", "format": "date-time", "title": "Received At", "type": "string" }, "sha256": { "description": "The SHA-256 of the part as Core received it", "title": "Sha256", "type": "string" }, "size_bytes": { "description": "The part's size in bytes", "title": "Size Bytes", "type": "integer" } }, "required": [ "part_number", "size_bytes", "sha256", "received_at" ], "title": "UploadPartRead", "type": "object" }, "UploadSessionCreate": { "description": "What a caller declares to open an upload session.", "properties": { "filename": { "description": "The file's name", "maxLength": 1024, "minLength": 1, "title": "Filename", "type": "string" }, "media_type": { "description": "The file's media type, such as `video/mp4`", "maxLength": 255, "minLength": 1, "title": "Media Type", "type": "string" }, "sha256": { "anyOf": [ { "pattern": "^[0-9a-f]{64}$", "type": "string" }, { "type": "null" } ], "description": "The SHA-256 of the whole file as lower-case hex; when given, completion fails with `digest_mismatch` unless the stored bytes match it", "title": "Sha256" }, "size_bytes": { "description": "The file's exact size in bytes; held to the session ceiling before any part is sent", "exclusiveMinimum": 0.0, "title": "Size Bytes", "type": "integer" }, "target": { "description": "What the session ends as: a file (`kind: file`) or a knowledge source on a collection (`kind: source`)", "discriminator": { "mapping": { "file": "#/components/schemas/FileTarget", "source": "#/components/schemas/SourceTarget" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/FileTarget" }, { "$ref": "#/components/schemas/SourceTarget" } ], "title": "Target" } }, "required": [ "filename", "media_type", "size_bytes", "target" ], "title": "UploadSessionCreate", "type": "object" }, "UploadSessionRead": { "description": "An upload session as every route answers it.", "properties": { "collection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The collection the file lands in; the one named, or null until completion resolves the caller's own", "title": "Collection Id" }, "created_at": { "description": "When it was opened", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Who opened it: a key's id, or `operator:`", "title": "Created By", "type": "string" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why the session failed: `parts_missing`, `size_mismatch`, `digest_mismatch`, `collection_unavailable`, `completion_lost`, `key_revoked` (the key that opened it can no longer store) or `tenant_unavailable` (the organisation is suspended or being deleted); null otherwise", "title": "Error Code" }, "expires_at": { "description": "When an open session is expired and its parts dropped; a session that ended still answers for one more TTL past it", "format": "date-time", "title": "Expires At", "type": "string" }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The file the session became, once completed, for a session that ends as a file; null otherwise", "title": "File Id" }, "filename": { "description": "The file's name as declared", "title": "Filename", "type": "string" }, "id": { "description": "Session id", "title": "Id", "type": "string" }, "labels": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "the labels the rules over this row's kind read, as label -> a value or a list of values, read back exactly as written", "title": "Labels", "type": "object" }, "media_type": { "description": "The file's media type as declared", "title": "Media Type", "type": "string" }, "object": { "const": "upload_session", "default": "upload_session", "description": "The object's type", "title": "Object", "type": "string" }, "part_count": { "description": "How many parts the file is cut into, numbered from 1", "title": "Part Count", "type": "integer" }, "part_size_bytes": { "description": "The exact size of every part but the last, which is the remainder", "title": "Part Size Bytes", "type": "integer" }, "parts": { "anyOf": [ { "items": { "$ref": "#/components/schemas/UploadPartRead" }, "type": "array" }, { "type": "null" } ], "description": "Every part received so far, by number; null on a listing, where only the count is answered -- read the session for its parts", "title": "Parts" }, "parts_received": { "description": "How many of the parts have been received", "title": "Parts Received", "type": "integer" }, "size_bytes": { "description": "The file's declared size in bytes", "title": "Size Bytes", "type": "integer" }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The knowledge source the session became, once completed, for a session that ends as a source; null otherwise", "title": "Source Id" }, "status": { "description": "'open' while parts may be sent, 'completing' while Core assembles and stores the file, 'completed' once it is stored, 'failed' when it could not be, 'aborted' when the caller dropped it and 'expired' when it stayed open too long", "enum": [ "open", "completing", "completed", "failed", "aborted", "expired" ], "title": "Status", "type": "string" }, "target_kind": { "description": "What the session ends as", "enum": [ "file", "source" ], "title": "Target Kind", "type": "string" }, "updated_at": { "description": "When it last moved", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "status", "filename", "media_type", "size_bytes", "part_size_bytes", "part_count", "parts_received", "parts", "target_kind", "collection_id", "labels", "expires_at", "file_id", "source_id", "error_code", "created_by", "created_at", "updated_at" ], "title": "UploadSessionRead", "type": "object" }, "UrlCitation": { "additionalProperties": false, "description": "A page the answer cited, spanning the marker that cited it.", "properties": { "end_index": { "description": "offset just past that marker in the same text, in Unicode code points", "title": "End Index", "type": "integer" }, "start_index": { "description": "offset of the marker in the text this annotates, in Unicode code points (not UTF-8 bytes, not UTF-16 units)", "title": "Start Index", "type": "integer" }, "title": { "description": "the page's title, or its URL when none was recorded", "title": "Title", "type": "string" }, "type": { "const": "url_citation", "default": "url_citation", "description": "the annotation's kind", "title": "Type", "type": "string" }, "url": { "description": "the page's URL, as the reader vendor finally answered it", "title": "Url", "type": "string" } }, "required": [ "url", "title", "start_index", "end_index" ], "title": "UrlCitation", "type": "object" }, "Usage": { "additionalProperties": false, "description": "Token usage for one turn.", "properties": { "input_tokens": { "description": "tokens consumed by context sent to the model", "title": "Input Tokens", "type": "integer" }, "input_tokens_details": { "$ref": "#/components/schemas/InputTokensDetails", "description": "what the input tokens were made of" }, "output_tokens": { "description": "tokens generated by the model", "title": "Output Tokens", "type": "integer" }, "output_tokens_details": { "$ref": "#/components/schemas/OutputTokensDetails", "description": "what the output tokens were made of" }, "total_tokens": { "description": "input_tokens plus output_tokens", "title": "Total Tokens", "type": "integer" } }, "required": [ "input_tokens", "output_tokens", "total_tokens" ], "title": "Usage", "type": "object" }, "UsageByKey": { "description": "`GET /tenants/{tenant_id}/usage/by-key` and its key-facing twin: what each key cost over a\nwindow, beside what the calls no key made cost (`docs/architecture/audit-and-metering.md`\n\"The API\").", "properties": { "cost_eur": { "description": "What every total here adds up to, items and keyless together", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Cost Eur", "type": "string" }, "items": { "description": "One total per key with rows in the window, ordered by cost_eur descending and then key_id ascending -- a key that spent nothing in the window is not listed", "items": { "$ref": "#/components/schemas/KeyUsage" }, "title": "Items", "type": "array" }, "keyless": { "$ref": "#/components/schemas/KeyUsage", "description": "Totals for the rows in the window that carry no key -- what people did from the console and the management routes. Always present, at zero when there were none" } }, "required": [ "items", "keyless", "cost_eur" ], "title": "UsageByKey", "type": "object" }, "UsageBySubject": { "description": "`GET /usage/by-subject` and `GET /tenants/{tenant_id}/usage/by-subject`: usage totalled\nper subject over an optional key and/or time window, for \"which people sit under this key\nand what did each cost\" -- the question `GET /usage?subject=` answers for one known\nperson and this answers across all of them at once\n(`docs/architecture/audit-and-metering.md` \"Usage per end user no longer has to be\ncorrelated by hand\").", "properties": { "cost_eur": { "description": "What every total here adds up to, items and unattributed together", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Cost Eur", "type": "string" }, "items": { "description": "One total per subject with rows in the window, ordered by cost_eur descending and then subject_id ascending, cut to the request's limit", "items": { "$ref": "#/components/schemas/SubjectUsage" }, "title": "Items", "type": "array" }, "subjects": { "description": "How many distinct subjects had rows in the window, whether or not their total made it into items -- so a caller can tell when the list was cut", "title": "Subjects", "type": "integer" }, "unattributed": { "$ref": "#/components/schemas/SubjectUsage", "description": "Totals for the rows in the window whose subject_id is null -- every management call, and every key call that named nobody. Always present, at zero when there were none" } }, "required": [ "items", "subjects", "unattributed", "cost_eur" ], "title": "UsageBySubject", "type": "object" }, "UsageCap": { "description": "One cap and what has been spent against it this month.", "properties": { "cost_cap_eur": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "Ceiling on what this subject may spend in the period, in euro; null when it has no cap, and 0 for a real cap of nothing at all. The key's own cap is weighed before its organisation's", "title": "Cost Cap Eur" }, "cost_cap_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When cost_cap_eur stops binding: the end of this period, for a cap set for this month only; null for a standing cap and where there is no cap", "title": "Cost Cap Until" }, "cost_eur": { "description": "What was spent in the period, in euro as an exact decimal, over every priced kind -- tokens, images, tool invocations, retrieval, parsing, crawling", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Cost Eur", "type": "string" } }, "required": [ "cost_cap_eur", "cost_eur" ], "title": "UsageCap", "type": "object" }, "UsageCaps": { "description": "`GET /usage/caps` and `GET /tenants/{tenant_id}/usage/caps`: the caps in force this\ncalendar month and what has been spent against each of them so far.", "properties": { "keys": { "description": "One entry per registered key on the management read; exactly the calling key on the key-facing one", "items": { "$ref": "#/components/schemas/KeyUsageCap" }, "title": "Keys", "type": "array" }, "period_end": { "description": "First instant of the next period, exclusive -- when every total below returns to zero and every cap lifts", "format": "date-time", "title": "Period End", "type": "string" }, "period_start": { "description": "First instant of the period the totals cover: the first of this month at 00:00:00 UTC, inclusive", "format": "date-time", "title": "Period Start", "type": "string" }, "tenant": { "$ref": "#/components/schemas/UsageCap", "description": "The organisation's own cap and month-to-date spend" }, "tenant_branch_cost_eur": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "What the organisation and every organisation below it spent in the period, in euro at the organisation's own prices: the figure its cap is weighed against when the cap counts the branch, with what an organisation erased from the branch used in the period where the cap goes on counting that. Null when it has no cap or its cap counts the organisation alone, where tenant.cost_eur is that figure, and null for a key without the management capability, which does not read what the organisations below spent", "title": "Tenant Branch Cost Eur" }, "tenant_cost_cap_counts": { "$ref": "#/components/schemas/CapCounts", "description": "What the organisation's cap is weighed against: `branch`, what it and every organisation below it used, or `own`, what it used itself" }, "unpriced": { "description": "How many of the organisation's usage rows in this period no price covered. Each of them costs zero against a cost cap, so this is what says a missing price has not quietly widened the budget", "title": "Unpriced", "type": "integer" } }, "required": [ "period_start", "period_end", "unpriced", "tenant", "tenant_cost_cap_counts", "tenant_branch_cost_eur", "keys" ], "title": "UsageCaps", "type": "object" }, "UsageDailyKindCost": { "description": "What one usage kind cost on one day of a daily series -- the split a stacked bar is drawn\nfrom (`docs/architecture/audit-and-metering.md#the-api`).", "properties": { "cost_eur": { "description": "What this kind's priced rows on this day cost, in euro as an exact decimal", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Cost Eur", "type": "string" }, "kind": { "description": "The usage kind these rows were metered as", "title": "Kind", "type": "string" }, "unpriced": { "description": "How many of this kind's rows on this day no price covered", "title": "Unpriced", "type": "integer" } }, "required": [ "kind", "cost_eur", "unpriced" ], "title": "UsageDailyKindCost", "type": "object" }, "UsageDailyTotal": { "description": "One UTC calendar day of `GET /usage/summary?interval=day` and its twins, and what it\ncost -- the response's `series` (`docs/architecture/audit-and-metering.md#the-api`).", "properties": { "by_kind": { "description": "This day's cost split by usage kind, one entry per kind that had rows on this day, ordered by kind; the entries add up to cost_eur, and a day with no rows has none", "items": { "$ref": "#/components/schemas/UsageDailyKindCost" }, "title": "By Kind", "type": "array" }, "cost_eur": { "description": "What every priced row recorded on this day cost, in euro as an exact decimal, at the price in force when each was recorded", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Cost Eur", "type": "string" }, "day": { "description": "This UTC calendar day, 00:00:00 to 24:00:00", "format": "date", "title": "Day", "type": "string" }, "messages_appended": { "description": "How many message items -- ItemRecord.type == 'message', never a tool call, its result, a reasoning block or a refusal -- were appended on this day, zero-filled the same way cost_eur is", "title": "Messages Appended", "type": "integer" }, "threads_created": { "description": "How many threads were created on this day -- zero-filled the same way cost_eur is (`docs/architecture/audit-and-metering.md#the-api`)", "title": "Threads Created", "type": "integer" }, "unpriced": { "description": "How many of this day's rows no price covered; those rows cost zero", "title": "Unpriced", "type": "integer" } }, "required": [ "day", "cost_eur", "unpriced", "threads_created", "messages_appended", "by_kind" ], "title": "UsageDailyTotal", "type": "object" }, "UsageRecordRead": { "description": "One usage row, as the key and operator usage APIs return it.", "properties": { "actor": { "description": "The acting key's id, or 'operator:' for a human management action", "title": "Actor", "type": "string" }, "agent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the agent whose turn wrote this row: for a nested agent turn the nested agent, for a tool the agent whose turn called it. Null when the work ran no agent, and on every row recorded before agents were named on usage", "title": "Agent" }, "cost_eur": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "What this row cost, in euro as an exact decimal, at the organisation's own price in force when it was recorded, every markup above it included -- the figure the usage summary adds into this row's group. Null where no price covers the row. Read at the time of the request, never stored", "title": "Cost Eur" }, "created_at": { "description": "When this usage was recorded", "format": "date-time", "title": "Created At", "type": "string" }, "helper": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the helper whose work wrote this row: the `helper` a turn on POST /responses named, on every row that turn wrote, a nested turn's and a tool's included, or `assist.` for one of Core's own helpers. Null for work no helper did, and on every row recorded before helpers were named on usage", "title": "Helper" }, "id": { "description": "Usage record id", "title": "Id", "type": "string" }, "input_tokens": { "description": "Input tokens, for model_tokens, embedding_tokens, cached_tokens, cache_write_tokens, audio_transcription billed in tokens and decision", "title": "Input Tokens", "type": "integer" }, "key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Key this usage is billed to; null when a human management caller caused it", "title": "Key Id" }, "kind": { "description": "What is metered", "title": "Kind", "type": "string" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Model id, for model_tokens or embedding_tokens", "title": "Model" }, "object": { "const": "usage_record", "default": "usage_record", "description": "The object's type", "title": "Object", "type": "string" }, "output_tokens": { "description": "Output tokens, for model_tokens", "title": "Output Tokens", "type": "integer" }, "quantity": { "description": "Count or byte size, for tool_invocation or retrieval -- and, on a row written before 2026-09-17, for the retired storage_bytes", "title": "Quantity", "type": "integer" }, "reasoning_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "How many of this row's output tokens the model spent thinking, for model_tokens; null where the provider reported nothing, which is not a claim that it thought nothing. Already inside `output_tokens`, and billed at the output price", "title": "Reasoning Tokens" }, "request_id": { "description": "Id of the request that caused this usage", "title": "Request Id", "type": "string" }, "response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Response this usage belongs to, when any", "title": "Response Id" }, "span_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Span within that trace; null when the deployment exports no telemetry", "title": "Span Id" }, "subject_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the request that wrote this row was for -- the calling application's own opaque identifier, or null for a request that named nobody (docs/architecture/subjects.md)", "title": "Subject Id" }, "tool_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tool name, for tool_invocation", "title": "Tool Name" }, "trace_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Trace this usage was recorded in; null when the deployment exports no telemetry", "title": "Trace Id" } }, "required": [ "id", "key_id", "actor", "request_id", "trace_id", "span_id", "response_id", "kind", "model", "tool_name", "input_tokens", "output_tokens", "reasoning_tokens", "quantity", "created_at" ], "title": "UsageRecordRead", "type": "object" }, "UsageSummary": { "description": "`GET /usage/summary`: usage totals grouped by kind, model and tool name -- and, when a\nmanagement caller asked for `include_children`, by organisation as well.", "properties": { "cost_eur": { "description": "What every total below adds up to, in euro as an exact decimal", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Cost Eur", "type": "string" }, "items": { "description": "One total per (kind, model, tool_name) group, per organisation", "items": { "$ref": "#/components/schemas/UsageTotal" }, "title": "Items", "type": "array" }, "messages_appended": { "description": "How many message items -- ItemRecord.type == 'message', whichever side spoke them, never a tool call, its result, a reasoning block or a refusal -- were appended in the window, on the same narrowing as threads_created (`docs/architecture/audit-and-metering.md#the-api`); never narrowed by request_id or response_id, which narrow the usage totals alone", "title": "Messages Appended", "type": "integer" }, "paid_eur": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "What every total below adds up to at the reading organisation's own prices -- what it pays for what its subtree is charged. Null on a summary of one organisation, and on a subtree summary with no totals at all", "title": "Paid Eur" }, "series": { "anyOf": [ { "items": { "$ref": "#/components/schemas/UsageDailyTotal" }, "type": "array" }, { "type": "null" } ], "description": "One entry per UTC calendar day inside `from`/`to`, present only when the request asked `interval=day`; the entries' cost_eur add up to this summary's own, and a day with no rows is a zero entry rather than a gap, which is what a chart needs (`docs/architecture/audit-and-metering.md#the-api`)", "title": "Series" }, "stored_bytes": { "description": "Bytes the organisation's files hold now, not a total over the window -- the sum of every blob a knowledge source of its owns, read at the instant this summary was built. With include_children, the whole subtree's sum, the way cost_eur is; never narrowed by request_id or response_id, which narrow the usage totals alone", "title": "Stored Bytes", "type": "integer" }, "threads_created": { "description": "How many threads were created in the window -- Thread.created_at inside `from`/`to`, narrowed to key_id the same way the totals above are. Counted straight over the thread table, on the same terms as cost_eur; never a rolling total, never stored (`docs/architecture/audit-and-metering.md#the-api`); never narrowed by request_id or response_id, which narrow the usage totals alone", "title": "Threads Created", "type": "integer" }, "trace_bytes": { "default": 0, "description": "Bytes the organisation's trace documents hold now, read at the same instant and on the same terms as stored_bytes. Its own figure and never summed into that one: a trace is the record of what was sent to a model rather than a file anybody uploaded, and an organisation weighing its trace window has to see what tracing alone costs (`docs/architecture/tracing.md`); never narrowed by request_id or response_id, which narrow the usage totals alone", "title": "Trace Bytes", "type": "integer" } }, "required": [ "items", "cost_eur", "stored_bytes", "threads_created", "messages_appended" ], "title": "UsageSummary", "type": "object" }, "UsageTotal": { "description": "Usage summed for one (kind, model, tool_name, agent, helper) group, in one organisation.", "properties": { "agent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Agent whose turns wrote this group's rows, by name; null for the rows no agent wrote, which are a group of their own", "title": "Agent" }, "cost_eur": { "description": "What this group cost, in euro as an exact decimal, at the price in force for each of its rows when that row was recorded -- so a price change inside the window splits the cost rather than re-pricing what came before it. The `cached_tokens` group carries the *correction* its model's cached rate is worth, which is zero or negative, and the `cache_write_tokens` group the surcharge its model's cache-write rate is worth, which is zero or positive -- never a second charge for tokens the model_tokens group already billed", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Cost Eur", "type": "string" }, "helper": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Helper whose work wrote this group's rows, by name; null for the rows no helper wrote, which are a group of their own", "title": "Helper" }, "input_tokens": { "description": "Sum of input tokens across the group", "title": "Input Tokens", "type": "integer" }, "kind": { "description": "What is metered", "title": "Kind", "type": "string" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Model id this total is for, when grouped by one", "title": "Model" }, "output_tokens": { "description": "Sum of output tokens across the group", "title": "Output Tokens", "type": "integer" }, "paid_eur": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "description": "The same usage costed at the reading organisation's own prices: what it pays for what this organisation is charged. Only on a subtree summary (`include_children=true`), where the two can differ -- the reading organisation's own row carries its `cost_eur` unchanged, and a summary of one organisation answers null because there it would only repeat `cost_eur`", "title": "Paid Eur" }, "quantity": { "description": "Sum of quantity across the group", "title": "Quantity", "type": "integer" }, "reasoning_tokens": { "description": "How many of this group's output tokens were spent thinking, summed over the rows whose provider reported it -- a group no provider reported any for sums to 0, not to null, so the rows themselves are where unreported stays distinguishable from none. Already inside `output_tokens`", "title": "Reasoning Tokens", "type": "integer" }, "tenant_id": { "description": "The organisation this total is for; its own id on a summary of one organisation, and what breaks a subtree's totals down when `include_children` summed several", "title": "Tenant Id", "type": "string" }, "tool_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tool name this total is for, when grouped by one", "title": "Tool Name" }, "unpriced": { "description": "How many rows in this group no price covered. Those rows cost zero, so a total with an `unpriced` above zero is a floor on what was actually spent", "title": "Unpriced", "type": "integer" } }, "required": [ "tenant_id", "kind", "model", "tool_name", "input_tokens", "output_tokens", "reasoning_tokens", "quantity", "cost_eur", "unpriced" ], "title": "UsageTotal", "type": "object" }, "ValidationError": { "properties": { "ctx": { "title": "Context", "type": "object" }, "input": { "title": "Input" }, "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "Location", "type": "array" }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" }, "ValueMatch": { "additionalProperties": false, "description": "A value a person may write when it is exactly this literal.", "properties": { "value": { "description": "the literal the written value must equal", "maxLength": 512, "title": "Value", "type": "string" } }, "required": [ "value" ], "title": "ValueMatch", "type": "object" }, "VendorOrigin": { "additionalProperties": false, "description": "Where the company serving a destination, and its ultimate parent, are established.", "properties": { "established_in": { "anyOf": [ { "description": "a zone ('eu', 'us', 'global', 'in-cluster' for this deployment itself) or an ISO 3166-1 alpha-2 country code in lowercase ('fr') as the finer claim", "pattern": "^(eu|us|in-cluster|global|[a-z]{2})$", "type": "string" }, { "type": "null" } ], "description": "where the company serving this destination is established. Null is not stated and reads as 'global', which a policy holding vendors to a narrower place refuses", "title": "Established In" }, "parent_in": { "anyOf": [ { "description": "a zone ('eu', 'us', 'global', 'in-cluster' for this deployment itself) or an ISO 3166-1 alpha-2 country code in lowercase ('fr') as the finer claim", "pattern": "^(eu|us|in-cluster|global|[a-z]{2})$", "type": "string" }, { "type": "null" } ], "description": "where that company's ultimate parent is established; a company nothing owns names its own place. Null is not stated and reads as 'global', never as 'no parent'", "title": "Parent In" } }, "title": "VendorOrigin", "type": "object" }, "VendorRequirement": { "additionalProperties": false, "description": "What one document requires of a destination's vendor; a part left null is not asked.", "properties": { "established_in": { "anyOf": [ { "items": { "description": "a zone ('eu', 'us', 'global', 'in-cluster' for this deployment itself) or an ISO 3166-1 alpha-2 country code in lowercase ('fr') as the finer claim", "pattern": "^(eu|us|in-cluster|global|[a-z]{2})$", "type": "string" }, "maxItems": 200, "minItems": 1, "type": "array" }, { "type": "null" } ], "description": "places the company serving a destination must be established in, in the hosting vocabulary ('eu' admits every member state and 'in-cluster', the deployment itself). Null does not ask; a list refuses a company established elsewhere, and one nobody placed, which is 'global'", "title": "Established In" }, "open_weights": { "default": false, "description": "true refuses a model whose weights are closed or whose openness nobody asserted; false, the default, does not ask. Read for models only", "title": "Open Weights", "type": "boolean" }, "parent_in": { "anyOf": [ { "items": { "description": "a zone ('eu', 'us', 'global', 'in-cluster' for this deployment itself) or an ISO 3166-1 alpha-2 country code in lowercase ('fr') as the finer claim", "pattern": "^(eu|us|in-cluster|global|[a-z]{2})$", "type": "string" }, "maxItems": 200, "minItems": 1, "type": "array" }, { "type": "null" } ], "description": "places that company's ultimate parent must be established in, in the same vocabulary; a company nothing owns is its own parent. Null does not ask; a list refuses a parent elsewhere, and one nobody placed, which is 'global'", "title": "Parent In" } }, "title": "VendorRequirement", "type": "object" }, "ViewTicketRead": { "description": "Where a browser opens one stored page, and until when.\n\nDeparts from `Read` over a row because there is no row: the ticket is sealed into\nthe URL and stored nowhere.", "properties": { "expires_at": { "description": "When the address stops opening the page", "format": "date-time", "title": "Expires At", "type": "string" }, "url": { "description": "Address that serves the page to whoever opens it, with no credential: load it in a sandboxed frame, and treat it as a secret until it expires", "title": "Url", "type": "string" } }, "required": [ "url", "expires_at" ], "title": "ViewTicketRead", "type": "object" }, "WebSearchFilters": { "additionalProperties": false, "description": "The vendor's filters on a web search.", "properties": { "allowed_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "the domains a search must keep to. Core's search keeps to none, so a list naming one is refused; empty or null is what Core does", "title": "Allowed Domains" } }, "title": "WebSearchFilters", "type": "object" }, "WebSearchLocation": { "additionalProperties": false, "description": "The approximate location of the person a search is for, as the vendor declares it.", "properties": { "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a city; accepted and ignored: a hint that does not change what the answer means, so Core never forwards it, stores it or answers it back", "title": "City" }, "country": { "anyOf": [ { "pattern": "^[A-Za-z]{2}$", "type": "string" }, { "type": "null" } ], "description": "a two-letter country code: honoured, as the country Core's search vendor takes results from (Brave's `country`)", "title": "Country" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a region; accepted and ignored: a hint that does not change what the answer means, so Core never forwards it, stores it or answers it back", "title": "Region" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "an IANA zone; accepted and ignored: a hint that does not change what the answer means, so Core never forwards it, stores it or answers it back", "title": "Timezone" }, "type": { "const": "approximate", "default": "approximate", "description": "always approximate", "title": "Type", "type": "string" } }, "title": "WebSearchLocation", "type": "object" }, "WebSearchServerToolIn": { "additionalProperties": false, "description": "Anthropic's web search server tool, answered by Core's own `builtin__web_search` (the\nuser's decision of 2026-10-03): decided exactly as a `core_tool` naming it, and its round\nanswered as Core's own (`mcp_tool_use` / `mcp_tool_result`), never as the vendor's\n`server_tool_use`. Every version the vendor's SDK declares is accepted.\n\n`max_uses` is honoured as the turn's cap on searches and `user_location.country` as the\ncountry results come from. The hints (the rest of `user_location`, `cache_control`,\n`strict`, and `response_inclusion`, which only shapes a call code execution made) are ignored;\n`defer_loading` routes the call, as on any entry (`ToolSearchToolIn`). What Core's search\ncannot keep to is refused by name in `translate_request`: a domain list, and a caller that is\nnot the model directly.", "properties": { "allowed_callers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "who may call the tool; refused unless it names `direct`, the only caller Core has", "title": "Allowed Callers" }, "allowed_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "refused when it names a domain: Core's search keeps to none", "title": "Allowed Domains" }, "blocked_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "refused when it names a domain: Core's search blocks none", "title": "Blocked Domains" }, "cache_control": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "the vendor's prompt-cache hint; accepted and ignored: a hint that does not change what the answer means, so it is neither refused nor forwarded, stored or echoed", "title": "Cache Control" }, "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "the vendor's tool-search hint: `true` on any entry puts the whole call behind the tool router, as `tool_search` `router` would, never this tool alone; Core's own `tool_search` wins over it", "title": "Defer Loading" }, "max_uses": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "how many searches this turn may run: honoured, a call past it answered with a fixed sentence instead of results while the turn goes on", "title": "Max Uses" }, "name": { "const": "web_search", "description": "always `web_search`", "title": "Name", "type": "string" }, "response_inclusion": { "anyOf": [ { "enum": [ "full", "excluded" ], "type": "string" }, { "type": "null" } ], "description": "what a code execution call's search returns; accepted and ignored: a hint that does not change what the answer means, so it is neither refused nor forwarded, stored or echoed, since Core runs no code that calls it and a direct call is always answered in full", "title": "Response Inclusion" }, "strict": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "schema strictness; accepted and ignored: a hint that does not change what the answer means, so it is neither refused nor forwarded, stored or echoed", "title": "Strict" }, "type": { "description": "tool kind: the vendor's web search, in any of its versions", "enum": [ "web_search_20250305", "web_search_20260209", "web_search_20260318" ], "title": "Type", "type": "string" }, "user_location": { "anyOf": [ { "$ref": "#/components/schemas/WebSearchLocation" }, { "type": "null" } ], "description": "where the person searching roughly is: its `country` is honoured as the country results come from, `city`, `region` and `timezone` are ignored hints" } }, "required": [ "type", "name" ], "title": "WebSearchServerToolIn", "type": "object" }, "WebSearchToolParam": { "additionalProperties": false, "description": "The Responses API's hosted `web_search` (and its preview and dated spellings), answered by\nCore's own `builtin__web_search` (the user's decision of 2026-10-03).\n\nA key allowed the builtin gets a real search, and the round comes back as Core's own tool\nround (an `mcp_call` with `server_label: builtin`), never as the vendor's `web_search_call`.\nEvery option the vendor declares is one of three things (`docs/architecture/responses.md`,\n\"Fields Core does not honour\"): guidance Core ignores (`search_context_size`,\n`user_location`), what Core's search already does (`external_web_access: false`, a\n`search_content_types` that allows text), or a constraint it cannot keep and refuses by name\n(`filters.allowed_domains`, a `search_content_types` without text).", "properties": { "external_web_access": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "whether the search may open live pages. Core's search reads its vendor's index and opens no page, which is what `false` asks; `true` permits more and requires nothing. Not in the vendor's Python SDK yet, sent by Codex on every request", "title": "External Web Access" }, "filters": { "anyOf": [ { "$ref": "#/components/schemas/WebSearchFilters" }, { "type": "null" } ], "description": "refused when it names a domain to keep to" }, "max_uses": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "how many searches this turn may run (Core extension: Anthropic's `max_uses`, which `POST /messages` carries here). A call past it is answered with a fixed sentence instead of results, and the turn goes on; a background run counts per pickup", "title": "Max Uses" }, "search_content_types": { "anyOf": [ { "items": { "enum": [ "text", "image" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "the kinds of result the search may return. Core's search returns text, so a list allowing text is what it does and a list without text is refused", "title": "Search Content Types" }, "search_context_size": { "anyOf": [ { "enum": [ "low", "medium", "high" ], "type": "string" }, { "type": "null" } ], "description": "how much context the search may use; accepted and ignored: a hint that does not change what the answer means, so Core never forwards it, stores it or answers it back", "title": "Search Context Size" }, "type": { "description": "The vendor's hosted web search, run as Core's own `builtin__web_search`: the registry decides it exactly as a `tool` entry naming that tool, so a key whose `tooling` does not name `web_search`, or a deployment with no search vendor, is refused on this entry", "enum": [ "web_search", "web_search_2025_08_26", "web_search_preview", "web_search_preview_2025_03_11" ], "title": "Type", "type": "string" }, "user_location": { "anyOf": [ { "$ref": "#/components/schemas/WebSearchLocation" }, { "type": "null" } ], "description": "where the person searching roughly is: its `country` is honoured, as the country results come from; `city`, `region` and `timezone` are hints Core's search takes no word for, ignored and not kept" } }, "required": [ "type" ], "title": "WebSearchToolParam", "type": "object" }, "WebsiteConnectorConfig": { "additionalProperties": false, "description": "A site crawled through Firecrawl; Core never dials the site itself.", "properties": { "allowed_patterns": { "description": "Glob patterns a crawled URL's path must match; empty crawls the whole site", "items": { "type": "string" }, "maxItems": 32, "title": "Allowed Patterns", "type": "array" }, "blocked_patterns": { "description": "Glob patterns a crawled URL's path must not match", "items": { "type": "string" }, "maxItems": 32, "title": "Blocked Patterns", "type": "array" }, "exclude_path_regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Items whose path matches this are skipped, on top of the built-in media/binary exclusion, which always applies and is never replaced", "title": "Exclude Path Regex" }, "include_path_regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Only items whose path matches this are synced; null matches all", "title": "Include Path Regex" }, "kind": { "const": "website", "description": "Connector kind", "title": "Kind", "type": "string" }, "max_depth": { "anyOf": [ { "maximum": 10.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "How many links deep from the root the crawl may follow; null leaves Firecrawl's own default, which is shallow", "title": "Max Depth" }, "max_pages": { "default": 100, "description": "Upper bound on pages one crawl fetches", "maximum": 1000.0, "minimum": 1.0, "title": "Max Pages", "type": "integer" }, "url": { "description": "Root URL to crawl", "maxLength": 2048, "minLength": 1, "title": "Url", "type": "string" } }, "required": [ "kind", "url" ], "title": "WebsiteConnectorConfig", "type": "object" }, "When": { "additionalProperties": false, "description": "The condition a member installs under: one `enum` parameter's value is one the condition\nnames. `{\"$param\": \"crm_kind\", \"equals\": \"hubspot\"}` or `{\"$param\": \"crm_kind\", \"in\":\n[\"hubspot\", \"pipedrive\"]}` -- exactly one of the two, so a condition always reads one way.\n\nA condition over an enum only, because an enum is the one parameter type whose every value\nthe publisher listed: the members a bundle may install are then a finite set a reader can\ncheck, and a console can say which member each choice switches on.", "properties": { "$param": { "description": "the enum parameter whose value decides whether this member installs", "maxLength": 64, "title": "$Param", "type": "string" }, "equals": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "install the member when the parameter's value is exactly this", "title": "Equals" }, "in": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 64, "minItems": 1, "type": "array" }, { "type": "null" } ], "description": "install the member when the parameter's value is one of these", "title": "In" } }, "required": [ "$param" ], "title": "When", "type": "object" }, "WorkflowCreate": { "description": "A new workflow and its first version.", "properties": { "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this version reads: a JSON Schema object with one property per variable, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A run's start sends their values in `variables`; an expression reads them as `run.variables.` and a tool step passes each to its tool. Never a secret: a run keeps its variables in the clear; omitted declares none" }, "description": { "default": "", "description": "what it is for", "maxLength": 1024, "title": "Description", "type": "string" }, "graph": { "additionalProperties": true, "description": "the graph: `nodes` and `edges`, each node of one of the kinds docs/architecture/workflows.md#node-kinds lists, as #the-graph there describes", "title": "Graph", "type": "object" }, "input_schema": { "additionalProperties": true, "description": "the JSON Schema (draft 2020-12) a run's input is held to; {} takes anything", "title": "Input Schema", "type": "object" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/InstallValue" }, "description": "The values this version's author sets, by name: `{type, value, allowed, description}` with `type` one of `string`, `number` and `enum`, never a secret. An expression reads them as `install.`; a marketplace install asks for each as a parameter; omitted declares none", "title": "Install Values", "type": "object" }, "labels": { "default": {}, "description": "the organisation's classification", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "metadata": { "additionalProperties": true, "default": {}, "description": "an opaque document the application attaches to this row, at most 16 KiB serialised: stored, returned and never read by Core or its rules", "title": "Metadata", "type": "object" }, "name": { "description": "unique within the organisation; never renamed", "pattern": "^[a-z0-9_-]{1,48}$", "title": "Name", "type": "string" } }, "required": [ "graph", "name" ], "title": "WorkflowCreate", "type": "object" }, "WorkflowDecisionAnswer": { "description": "The answer to a decision: the outcome chosen and what its form asks for. Not a\n`...Create`: an answer makes no resource of its own, it completes a step that exists.", "properties": { "fields": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "What the decision's form asks for, held to that form", "title": "Fields" }, "outcome": { "description": "One of the decision's outcomes", "maxLength": 48, "title": "Outcome", "type": "string" } }, "required": [ "outcome" ], "title": "WorkflowDecisionAnswer", "type": "object" }, "WorkflowDecisionRead": { "description": "One waiting decision the caller may answer, with what the answer is held to.", "properties": { "assignee_kind": { "description": "Who the decision is assigned to", "enum": [ "members", "subject", "key" ], "title": "Assignee Kind", "type": "string" }, "created_at": { "description": "When the decision started waiting", "format": "date-time", "title": "Created At", "type": "string" }, "deadline_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the decision's deadline passes", "title": "Deadline At" }, "form": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The JSON Schema the answer's fields are held to, if any", "title": "Form" }, "id": { "description": "The step's id, which the answer route names", "title": "Id", "type": "string" }, "instruction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "What is asked", "title": "Instruction" }, "node_id": { "description": "The decision's node", "title": "Node Id", "type": "string" }, "object": { "const": "workflow_decision", "default": "workflow_decision", "description": "The object's type", "title": "Object", "type": "string" }, "outcomes": { "description": "The outcomes the answer chooses between", "items": { "type": "string" }, "title": "Outcomes", "type": "array" }, "run_id": { "description": "The run that waits", "title": "Run Id", "type": "string" }, "subject_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the run is for", "title": "Subject Id" }, "workflow_id": { "description": "The run's workflow", "title": "Workflow Id", "type": "string" }, "workflow_name": { "description": "That workflow's name", "title": "Workflow Name", "type": "string" } }, "required": [ "id", "run_id", "workflow_id", "workflow_name", "node_id", "instruction", "outcomes", "form", "assignee_kind", "subject_id", "deadline_at", "created_at" ], "title": "WorkflowDecisionRead", "type": "object" }, "WorkflowRead": { "description": "A workflow, with its latest version.", "properties": { "created_at": { "description": "When it was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created it", "title": "Created By", "type": "string" }, "description": { "description": "What it is for", "title": "Description", "type": "string" }, "draft_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The newest draft's version number, when there is one; read on the management twin only, and always null where a key reads", "title": "Draft Version" }, "highest_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The highest version number handed out, draft or published: the next version takes this number plus one. Read on the management twin only, and null where a key reads", "title": "Highest Version" }, "id": { "description": "Workflow id", "title": "Id", "type": "string" }, "labels": { "description": "The organisation's classification", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "latest": { "$ref": "#/components/schemas/WorkflowVersionRead", "description": "That version; on the management twin, the newest draft while nothing is published" }, "latest_version": { "description": "The number of its highest published version, the one a run naming no version starts; 0 for a workflow with only drafts, which only the management twin reads", "title": "Latest Version", "type": "integer" }, "metadata": { "additionalProperties": true, "description": "The opaque document attached to it", "title": "Metadata", "type": "object" }, "name": { "description": "Unique name within the organisation", "title": "Name", "type": "string" }, "object": { "const": "workflow", "default": "workflow", "description": "The object's type", "title": "Object", "type": "string" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/OriginRead" }, { "type": "null" } ], "description": "Which publication installed this workflow, for a copy a subscription installed; null for a workflow the organisation wrote itself" }, "updated_at": { "description": "When it last changed", "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "name", "description", "labels", "metadata", "latest_version", "latest", "created_by", "created_at", "updated_at" ], "title": "WorkflowRead", "type": "object" }, "WorkflowRunCreate": { "description": "A run to start, as the calling key.", "properties": { "input": { "description": "The run's input, held to the input schema", "title": "Input" }, "labels": { "default": {}, "description": "labels the rules over this row's kind read, as label -> a value or a list of 1 to 32 distinct values, each of 1 to 256 characters; at most 32 names. Held to the organisation's vocabulary and, for a request naming a person, to `writable_labels`, as on a thread: every thread the run's steps start, and every run they start, inherits them. The workflow's own labels are not passed on", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "subject_id": { "anyOf": [ { "pattern": "^[A-Za-z0-9._:@-]{1,128}$", "type": "string" }, { "type": "null" } ], "description": "The person every step is for; only the id is stored. A credential bound to one person may name only that person, and names her when it names nobody", "title": "Subject Id", "x-core-subject-alias": true }, "variables": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "The values for the call variables the version declares, as a flat object of names to strings, numbers or booleans; a name it does not declare is ignored. `variables.` is refused (422) for a required variable with no value or a value its declaration does not admit. A run keeps them in the clear, reads them as `run.variables.` and hands each to the tool steps whose tools declare it; they are never echoed", "propertyNames": { "maxLength": 64, "minLength": 1 }, "title": "Variables", "type": "object" }, "version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "The version to run; the latest when left out", "title": "Version" } }, "title": "WorkflowRunCreate", "type": "object" }, "WorkflowRunDetail": { "description": "One run with every step it has so far.", "properties": { "created_at": { "description": "When it was started", "format": "date-time", "title": "Created At", "type": "string" }, "deadline_at": { "description": "When it expires if still open", "format": "date-time", "title": "Deadline At", "type": "string" }, "ended_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When it ended", "title": "Ended At" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Core's fixed code of a failed run", "title": "Error Code" }, "id": { "description": "Run id", "title": "Id", "type": "string" }, "input": { "description": "Its input", "title": "Input" }, "item_index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The position of the item of a `map` step's list it runs for", "title": "Item Index" }, "labels": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "The labels its start named, which every thread its steps start inherits", "title": "Labels", "type": "object" }, "object": { "const": "workflow_run", "default": "workflow_run", "description": "The object's type", "title": "Object", "type": "string" }, "output": { "description": "Its output once it completed", "title": "Output" }, "parent_run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The run whose `workflow` or `map` step started it", "title": "Parent Run Id" }, "parent_step_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "That step", "title": "Parent Step Id" }, "root_run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The run at the top of the tree it is a child in; null for a run no step started", "title": "Root Run Id" }, "run_as_key_id": { "description": "The key every step acts as", "title": "Run As Key Id", "type": "string" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When its first advance ran", "title": "Started At" }, "status": { "description": "Where it stands", "enum": [ "queued", "running", "waiting", "completed", "failed", "cancelled", "expired" ], "title": "Status", "type": "string" }, "steps": { "description": "Its steps, in the order they were written", "items": { "$ref": "#/components/schemas/WorkflowStepRead" }, "title": "Steps", "type": "array" }, "subject_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person it is for", "title": "Subject Id" }, "trigger_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The schedule, trigger, task or parent step that started it", "title": "Trigger Id" }, "trigger_kind": { "description": "What started it: `manual`, `schedule`, `event`, `webhook`, `task`, or `workflow` for a run a step of another run started", "title": "Trigger Kind", "type": "string" }, "version": { "description": "The version it pinned", "title": "Version", "type": "integer" }, "workflow_id": { "description": "The workflow run", "title": "Workflow Id", "type": "string" }, "workflow_name": { "description": "That workflow's name", "title": "Workflow Name", "type": "string" }, "workflow_withdrawn": { "description": "Whether that workflow was a copy its publication took back: it is in no list and answers 404 by its id, a new workflow may carry its name, and its runs stay readable here", "title": "Workflow Withdrawn", "type": "boolean" } }, "required": [ "id", "workflow_id", "workflow_name", "workflow_withdrawn", "version", "status", "error_code", "input", "output", "run_as_key_id", "subject_id", "labels", "trigger_kind", "trigger_id", "deadline_at", "created_at", "started_at", "ended_at", "steps" ], "title": "WorkflowRunDetail", "type": "object" }, "WorkflowRunInstructed": { "additionalProperties": false, "description": "A run to hand to a service account: it acts as the account's key, for `sa:`, so it\nnames no person of its own (`docs/architecture/service-accounts.md#who-may-instruct`).", "properties": { "input": { "description": "The run's input, held to the input schema", "title": "Input" }, "labels": { "default": {}, "description": "labels the rules over this row's kind read, as label -> a value or a list of 1 to 32 distinct values, each of 1 to 256 characters; at most 32 names. Held to the organisation's vocabulary and, for a request naming a person, to `writable_labels`, as on a run", "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "title": "Labels", "type": "object" }, "variables": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "The values for the call variables the version declares, as on a run", "propertyNames": { "maxLength": 64, "minLength": 1 }, "title": "Variables", "type": "object" }, "version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "The version to run; the latest when left out", "title": "Version" }, "workflow_id": { "description": "A workflow the account's key reaches", "maxLength": 64, "title": "Workflow Id", "type": "string" } }, "required": [ "workflow_id" ], "title": "WorkflowRunInstructed", "type": "object" }, "WorkflowRunRead": { "description": "One run, without its steps.", "properties": { "created_at": { "description": "When it was started", "format": "date-time", "title": "Created At", "type": "string" }, "deadline_at": { "description": "When it expires if still open", "format": "date-time", "title": "Deadline At", "type": "string" }, "ended_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When it ended", "title": "Ended At" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Core's fixed code of a failed run", "title": "Error Code" }, "id": { "description": "Run id", "title": "Id", "type": "string" }, "input": { "description": "Its input", "title": "Input" }, "item_index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The position of the item of a `map` step's list it runs for", "title": "Item Index" }, "labels": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "The labels its start named, which every thread its steps start inherits", "title": "Labels", "type": "object" }, "object": { "const": "workflow_run", "default": "workflow_run", "description": "The object's type", "title": "Object", "type": "string" }, "output": { "description": "Its output once it completed", "title": "Output" }, "parent_run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The run whose `workflow` or `map` step started it", "title": "Parent Run Id" }, "parent_step_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "That step", "title": "Parent Step Id" }, "root_run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The run at the top of the tree it is a child in; null for a run no step started", "title": "Root Run Id" }, "run_as_key_id": { "description": "The key every step acts as", "title": "Run As Key Id", "type": "string" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When its first advance ran", "title": "Started At" }, "status": { "description": "Where it stands", "enum": [ "queued", "running", "waiting", "completed", "failed", "cancelled", "expired" ], "title": "Status", "type": "string" }, "subject_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person it is for", "title": "Subject Id" }, "trigger_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The schedule, trigger, task or parent step that started it", "title": "Trigger Id" }, "trigger_kind": { "description": "What started it: `manual`, `schedule`, `event`, `webhook`, `task`, or `workflow` for a run a step of another run started", "title": "Trigger Kind", "type": "string" }, "version": { "description": "The version it pinned", "title": "Version", "type": "integer" }, "workflow_id": { "description": "The workflow run", "title": "Workflow Id", "type": "string" }, "workflow_name": { "description": "That workflow's name", "title": "Workflow Name", "type": "string" }, "workflow_withdrawn": { "description": "Whether that workflow was a copy its publication took back: it is in no list and answers 404 by its id, a new workflow may carry its name, and its runs stay readable here", "title": "Workflow Withdrawn", "type": "boolean" } }, "required": [ "id", "workflow_id", "workflow_name", "workflow_withdrawn", "version", "status", "error_code", "input", "output", "run_as_key_id", "subject_id", "labels", "trigger_kind", "trigger_id", "deadline_at", "created_at", "started_at", "ended_at" ], "title": "WorkflowRunRead", "type": "object" }, "WorkflowStepChildren": { "description": "What the runs a `workflow` or `map` step started add up to: a `map`'s progress.", "properties": { "cancelled": { "description": "How many were cancelled", "title": "Cancelled", "type": "integer" }, "completed": { "description": "How many completed", "title": "Completed", "type": "integer" }, "failed": { "description": "How many ended failed or expired", "title": "Failed", "type": "integer" }, "open": { "description": "How many are queued, running or waiting", "title": "Open", "type": "integer" }, "started": { "description": "How many of them were started", "title": "Started", "type": "integer" }, "total": { "description": "How many runs the step starts in all: a map's items, or 1", "title": "Total", "type": "integer" } }, "required": [ "total", "started", "open", "completed", "failed", "cancelled" ], "title": "WorkflowStepChildren", "type": "object" }, "WorkflowStepRead": { "description": "One step of a run: what its node received and produced, or how it failed. A subject token\nthat is not a decision's assignee reads that step without its instruction, assignee, form,\nand the answer's fields and author.", "properties": { "assignee_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The key or the person a decision is assigned to; null for members and for an agent", "title": "Assignee Id" }, "assignee_kind": { "anyOf": [ { "enum": [ "members", "subject", "key", "agent" ], "type": "string" }, { "type": "null" } ], "description": "Who may answer a decision; `agent` for one a stored agent answers in a turn of its own, which no caller answers and whose output's `decided_by` names the agent, its version and the response of that turn", "title": "Assignee Kind" }, "assignee_users": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The ids of the administrators a members decision is narrowed to, if any", "title": "Assignee Users" }, "attempt": { "description": "How many retries came before this attempt", "title": "Attempt", "type": "integer" }, "child_run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The run a `workflow` step started, its newest attempt's; read it through `GET /workflow_runs/{id}`, which answers 404 where the reader's rules withhold its workflow", "title": "Child Run Id" }, "children": { "anyOf": [ { "$ref": "#/components/schemas/WorkflowStepChildren" }, { "type": "null" } ], "description": "The runs a `workflow` or `map` step started, counted; the runs themselves are `GET /workflow_runs?trigger_id=`. Null on every other kind" }, "deadline_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When an agent step times out, or a decision's deadline passes", "title": "Deadline At" }, "ended_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When it ended", "title": "Ended At" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Core's fixed code of a failure", "title": "Error Code" }, "form": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The JSON Schema a decision's answer fields are held to, if any", "title": "Form" }, "id": { "description": "Step id", "title": "Id", "type": "string" }, "input": { "description": "What the node received", "title": "Input" }, "instruction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "What a decision asks its assignee", "title": "Instruction" }, "iteration": { "description": "Always 0: a map's items are runs, not steps", "title": "Iteration", "type": "integer" }, "kind": { "description": "Its node's kind", "title": "Kind", "type": "string" }, "node_id": { "description": "Its node", "title": "Node Id", "type": "string" }, "outcomes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The outcomes a decision chooses between", "title": "Outcomes" }, "output": { "description": "What it produced", "title": "Output" }, "response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The background response an agent or prompt step drove, or the turn of the agent a decision was put to", "title": "Response Id" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When it started running", "title": "Started At" }, "status": { "description": "Where it stands", "enum": [ "queued", "running", "waiting", "completed", "failed", "skipped", "cancelled" ], "title": "Status", "type": "string" }, "taken": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The nodes the edges a condition or a decision took lead to", "title": "Taken" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The thread that response ran on", "title": "Thread Id" }, "wake_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When a retry's backoff ends, or a wait step's time comes", "title": "Wake At" } }, "required": [ "id", "node_id", "iteration", "kind", "status", "attempt", "input", "output", "error_code", "taken", "response_id", "thread_id", "wake_at", "deadline_at", "instruction", "assignee_kind", "assignee_id", "assignee_users", "outcomes", "form", "started_at", "ended_at" ], "title": "WorkflowStepRead", "type": "object" }, "WorkflowToolParam": { "additionalProperties": false, "description": "A workflow, offered to this turn as one tool (`workflow__`): the model calls it with\nthe run's input and reads a task's handle at once, and the run's output reaches the\nconversation as that task's result (`docs/architecture/workflows.md`, \"A workflow as a task\ntool\"). Always started in the background, so a turn that can hold no task is not offered it.\n\nThe name is the workflow's own and never an id, and the entry pins no version: the run starts\non the workflow's newest version.", "properties": { "name": { "description": "the workflow's name", "maxLength": 64, "title": "Name", "type": "string" }, "type": { "const": "workflow", "default": "workflow", "description": "tool param kind", "title": "Type", "type": "string" } }, "required": [ "name" ], "title": "WorkflowToolParam", "type": "object" }, "WorkflowTriggerCreate": { "additionalProperties": false, "description": "Body of `POST /workflow_triggers`: the runs act as the key that wrote the trigger.", "properties": { "description": { "default": "", "description": "what it is for", "maxLength": 1024, "title": "Description", "type": "string" }, "enabled": { "default": true, "description": "whether a matching event, or a signed request, starts a run", "title": "Enabled", "type": "boolean" }, "event_kind": { "anyOf": [ { "enum": [ "thread.item.created", "response.completed", "response.failed", "response.incomplete", "response.cancelled", "response.check_failed", "run.suspended", "run.resumed", "run.approval.requested", "run.approval.decided", "thread.task.started", "thread.task.completed", "thread.task.failed", "thread.task.cancelled", "thread.task.expired", "knowledge.source.created", "knowledge.source.updated", "knowledge.source.deleted", "knowledge.source.restored", "knowledge.source.ingested", "knowledge.index.reindex_requested", "knowledge.index.reindexed", "knowledge.connector.synced", "memory.commitment_overdue", "mail.received", "improvements.proposal.created", "improvements.analysis.finished", "workflow.run.started", "workflow.run.completed", "workflow.run.failed", "workflow.run.cancelled", "workflow.run.expired", "workflow.decision.requested", "workflow.decision.decided", "workflow.decision.expired", "datastore.record.written", "datastore.record.deleted", "usage.threshold_reached", "usage.cap_exceeded" ], "type": "string" }, { "type": "null" } ], "description": "the curated event kind an event trigger listens for, and required for one; `response.*`, `run.*` and `thread.*` are refused, since a run's own steps produce them. A webhook trigger names none", "title": "Event Kind" }, "filter": { "description": "the values the event's `refs` must carry for the trigger to match, compared for equality; {} matches every event of the kind; a webhook trigger takes none", "maxProperties": 8, "patternProperties": { "^[a-z_]{1,48}$": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "integer" } ] } }, "title": "Filter", "type": "object" }, "input": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "the JMESPath expression that gives a run its input: for an event trigger over `event` (`id`, `type`, `refs`, `subject_id`, `created_at`), for a webhook trigger over `webhook` (`body`, `delivery`, `received_at`); left out, the run's input is that event document, or the request's body", "title": "Input" }, "source": { "default": "event", "description": "what starts a run: `event`, an event of `event_kind`, or `webhook`, a signed request to the trigger's own address", "enum": [ "event", "webhook" ], "title": "Source", "type": "string" }, "subject_id": { "anyOf": [ { "pattern": "^[A-Za-z0-9._:@-]{1,128}$", "type": "string" }, { "type": "null" } ], "description": "The person every run it starts is for; only the id is stored. A credential bound to one person may name only that person", "title": "Subject Id", "x-core-subject-alias": true }, "workflow": { "description": "the name of the workflow a match starts", "pattern": "^[a-z0-9_-]{1,48}$", "title": "Workflow", "type": "string" } }, "required": [ "workflow" ], "title": "WorkflowTriggerCreate", "type": "object" }, "WorkflowTriggerRead": { "description": "One trigger, without a webhook trigger's secret.", "properties": { "created_at": { "description": "When it was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created it", "title": "Created By", "type": "string" }, "description": { "description": "What it is for", "title": "Description", "type": "string" }, "enabled": { "description": "Whether a matching event, or a signed request, starts a run", "title": "Enabled", "type": "boolean" }, "event_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The event kind an event trigger listens for; null on a webhook trigger", "title": "Event Kind" }, "filter": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "description": "The values an event's `refs` must carry", "title": "Filter", "type": "object" }, "id": { "description": "Trigger id", "title": "Id", "type": "string" }, "input": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The expression that gives a run its input; null hands the event document, or the request's body", "title": "Input" }, "object": { "const": "workflow_trigger", "default": "workflow_trigger", "description": "The object's type", "title": "Object", "type": "string" }, "run_as_key_id": { "description": "The key every run it starts acts as", "title": "Run As Key Id", "type": "string" }, "source": { "description": "What starts a run: an event, or a signed request", "enum": [ "event", "webhook" ], "title": "Source", "type": "string" }, "subject_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person every run it starts is for", "title": "Subject Id" }, "updated_at": { "description": "When it last changed", "format": "date-time", "title": "Updated At", "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The address a sender posts to, on a webhook trigger; null on an event trigger, and where this deployment names no public address", "title": "Url" }, "workflow": { "description": "The name of the workflow a match starts a run of", "title": "Workflow", "type": "string" } }, "required": [ "id", "workflow", "description", "source", "event_kind", "filter", "input", "run_as_key_id", "subject_id", "enabled", "created_by", "created_at", "updated_at" ], "title": "WorkflowTriggerRead", "type": "object" }, "WorkflowTriggerSecret": { "description": "A trigger as its create and its secret's rotation answer it: with a webhook trigger's\nsigning secret, which Core cannot show again.", "properties": { "created_at": { "description": "When it was created", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that created it", "title": "Created By", "type": "string" }, "description": { "description": "What it is for", "title": "Description", "type": "string" }, "enabled": { "description": "Whether a matching event, or a signed request, starts a run", "title": "Enabled", "type": "boolean" }, "event_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The event kind an event trigger listens for; null on a webhook trigger", "title": "Event Kind" }, "filter": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "description": "The values an event's `refs` must carry", "title": "Filter", "type": "object" }, "id": { "description": "Trigger id", "title": "Id", "type": "string" }, "input": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The expression that gives a run its input; null hands the event document, or the request's body", "title": "Input" }, "object": { "const": "workflow_trigger", "default": "workflow_trigger", "description": "The object's type", "title": "Object", "type": "string" }, "run_as_key_id": { "description": "The key every run it starts acts as", "title": "Run As Key Id", "type": "string" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The secret a sender signs every request with (`Artific-Signature`), on a webhook trigger; store it now, it is not shown again. Null on an event trigger", "title": "Secret" }, "source": { "description": "What starts a run: an event, or a signed request", "enum": [ "event", "webhook" ], "title": "Source", "type": "string" }, "subject_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person every run it starts is for", "title": "Subject Id" }, "updated_at": { "description": "When it last changed", "format": "date-time", "title": "Updated At", "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The address a sender posts to, on a webhook trigger; null on an event trigger, and where this deployment names no public address", "title": "Url" }, "workflow": { "description": "The name of the workflow a match starts a run of", "title": "Workflow", "type": "string" } }, "required": [ "id", "workflow", "description", "source", "event_kind", "filter", "input", "run_as_key_id", "subject_id", "enabled", "created_by", "created_at", "updated_at", "secret" ], "title": "WorkflowTriggerSecret", "type": "object" }, "WorkflowTriggerUpdate": { "additionalProperties": false, "description": "The fields a trigger changes in place; an absent field keeps what is stored. The workflow\nand the event kind are fixed: write another trigger.", "properties": { "description": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "what it is for", "title": "Description" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "whether a matching event, or a signed request, starts a run", "title": "Enabled" }, "filter": { "anyOf": [ { "maxProperties": 8, "patternProperties": { "^[a-z_]{1,48}$": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "integer" } ] } }, "type": "object" }, { "type": "null" } ], "description": "the values the event's `refs` must carry for the trigger to match, compared for equality; {} matches every event of the kind; a webhook trigger takes none", "title": "Filter" }, "input": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "the JMESPath expression that gives a run its input: for an event trigger over `event` (`id`, `type`, `refs`, `subject_id`, `created_at`), for a webhook trigger over `webhook` (`body`, `delivery`, `received_at`); left out, the run's input is that event document, or the request's body; null hands the event document, or the body", "title": "Input" }, "subject_id": { "anyOf": [ { "pattern": "^[A-Za-z0-9._:@-]{1,128}$", "type": "string" }, { "type": "null" } ], "description": "The person every run it starts is for, or null for nobody", "title": "Subject Id", "x-core-subject-alias": true } }, "title": "WorkflowTriggerUpdate", "type": "object" }, "WorkflowUpdate": { "description": "The fields a workflow changes in place; an absent field keeps what is stored.", "properties": { "description": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "what it is for", "title": "Description" }, "labels": { "anyOf": [ { "maxProperties": 32, "patternProperties": { "^[A-Za-z0-9_.:-]{1,64}$": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } ] } }, "type": "object" }, { "type": "null" } ], "description": "the organisation's classification", "title": "Labels" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "an opaque document the application attaches to this row, at most 16 KiB serialised: stored, returned and never read by Core or its rules; replaces it whole, {} clears it", "title": "Metadata" } }, "title": "WorkflowUpdate", "type": "object" }, "WorkflowValidation": { "description": "What `POST /workflows/validate` answers for a version that would be stored.", "properties": { "valid": { "const": true, "default": true, "description": "Always true; a refusal is a 422", "title": "Valid", "type": "boolean" } }, "title": "WorkflowValidation", "type": "object" }, "WorkflowVersionRead": { "description": "One immutable version.", "properties": { "acted_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person the writing key acted for, as its request named them; null when it acted for nobody and for a person on the management twin, whom `created_by` already names. Cleared when that person is erased", "title": "Acted For" }, "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this version reads: a JSON Schema object with one property per variable, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A run's start sends their values in `variables`; an expression reads them as `run.variables.` and a tool step passes each to its tool. Never a secret: a run keeps its variables in the clear. A sealed version answers them too, because a caller must know what to send" }, "created_at": { "description": "When it was written", "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "description": "Key id, or `operator:`, that wrote it", "title": "Created By", "type": "string" }, "graph": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "The graph; null for a version a sealed publication installed, which withholds it", "title": "Graph" }, "input_schema": { "additionalProperties": true, "description": "The JSON Schema of a run's input", "title": "Input Schema", "type": "object" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/InstallValue" }, "description": "The values this version's author sets, by name: `{type, value, allowed, description}` with `type` one of `string`, `number` and `enum`, never a secret. An expression reads them as `install.`; a marketplace install asks for each as a parameter", "title": "Install Values", "type": "object" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this version was published; null while it is a draft, which no key lists, reads or runs", "title": "Published At" }, "sealed": { "default": false, "description": "Whether this version was installed under terms that withhold its graph", "title": "Sealed", "type": "boolean" }, "state": { "default": "published", "description": "`published` for a version keys list, read and run; `draft` for one only the management twin lists, reads, publishes and discards", "enum": [ "draft", "published" ], "title": "State", "type": "string" }, "version": { "description": "Its number within the workflow", "title": "Version", "type": "integer" }, "workflow_id": { "description": "The workflow", "title": "Workflow Id", "type": "string" } }, "required": [ "workflow_id", "version", "graph", "input_schema", "install_values", "call_variables", "created_by", "acted_for", "created_at" ], "title": "WorkflowVersionRead", "type": "object" }, "WorkflowVersionWrite": { "description": "A version's body: the graph and the JSON Schema of a run's input.", "properties": { "call_variables": { "$ref": "#/components/schemas/CallVariables", "description": "The call variables this version reads: a JSON Schema object with one property per variable, each a `string`, `number`, `integer` or `boolean` with an optional `description`, `enum` and `default`, and a `required` list. A run's start sends their values in `variables`; an expression reads them as `run.variables.` and a tool step passes each to its tool. Never a secret: a run keeps its variables in the clear; omitted declares none" }, "graph": { "additionalProperties": true, "description": "the graph: `nodes` and `edges`, each node of one of the kinds docs/architecture/workflows.md#node-kinds lists, as #the-graph there describes", "title": "Graph", "type": "object" }, "input_schema": { "additionalProperties": true, "description": "the JSON Schema (draft 2020-12) a run's input is held to; {} takes anything", "title": "Input Schema", "type": "object" }, "install_values": { "additionalProperties": { "$ref": "#/components/schemas/InstallValue" }, "description": "The values this version's author sets, by name: `{type, value, allowed, description}` with `type` one of `string`, `number` and `enum`, never a secret. An expression reads them as `install.`; a marketplace install asks for each as a parameter; omitted declares none", "title": "Install Values", "type": "object" } }, "required": [ "graph" ], "title": "WorkflowVersionWrite", "type": "object" }, "WorkflowsConfig": { "additionalProperties": false, "description": "The `workflows` capability; no configuration yet (`docs/architecture/workflows.md`).", "properties": {}, "title": "WorkflowsConfig", "type": "object" }, "ZendeskConnectorConfig": { "additionalProperties": false, "description": "One Zendesk Help Center's published articles, for one locale.", "properties": { "api_token": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "description": "API token; write-only, sealed at rest and never returned", "title": "Api Token" }, "email": { "description": "Agent email for API-token auth", "maxLength": 320, "minLength": 1, "title": "Email", "type": "string" }, "exclude_path_regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Items whose path matches this are skipped, on top of the built-in media/binary exclusion, which always applies and is never replaced", "title": "Exclude Path Regex" }, "include_path_regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Only items whose path matches this are synced; null matches all", "title": "Include Path Regex" }, "kind": { "const": "zendesk", "description": "Connector kind", "title": "Kind", "type": "string" }, "locale": { "anyOf": [ { "maxLength": 16, "type": "string" }, { "type": "null" } ], "description": "Help Center locale; null uses its default", "title": "Locale" }, "section_ids": { "description": "Restrict the sync to these section ids; empty syncs every section", "items": { "type": "string" }, "maxItems": 32, "title": "Section Ids", "type": "array" }, "subdomain": { "description": "Zendesk subdomain, e.g. 'acme' for acme.zendesk.com", "maxLength": 63, "minLength": 1, "title": "Subdomain", "type": "string" } }, "required": [ "kind", "subdomain", "email" ], "title": "ZendeskConnectorConfig", "type": "object" } }, "securitySchemes": { "ApiKeySecret": { "bearerFormat": "ack_...", "description": "A tenant's API key secret, issued once by Core when the key is registered and stored nowhere afterwards. Paste the secret itself, `ack_` and all; do not prefix it with `Bearer`. A browser may send it only from this deployment's own guide; a key any other page sends is refused. A subject token (`ast_...`) minted with the key is taken here too. Every route outside `/api/v1/tenants*`, `/api/v1/outbox*` and `/api/v1/me` takes this credential and no other.", "scheme": "bearer", "type": "http" } } }, "info": { "description": "Every operation an API key can call, and the two probes any caller may ask; the whole contract, including the administration a signed-in person reaches in the console, is `services/core/openapi.json` in the Artific Core repository.", "title": "Artific Core", "version": "0.1.0", "x-contract-digest": "85a644c0984a20d77d88e9e48be1b2bcfef0f1e217c344a4cf1ac1b9ec3ffa88" }, "openapi": "3.1.0", "paths": { "/api/health": { "get": { "description": "Report liveness.", "operationId": "get_health_api_health_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthRead" } } }, "description": "Successful Response" } }, "summary": "Get Health", "tags": [ "health" ] } }, "/api/ready": { "get": { "description": "Report readiness: the database must answer `SELECT 1`.\n\nNo configuration or DSN fragment ever appears in the response or the log: only the\nexception's type name (or, when no engine is configured at all, a fixed reason), enough to\nfind the bug without repeating what a caller (or an operator's connection string) supplied.\nAn unconfigured engine reads as \"not ready\" the same as an unreachable one.", "operationId": "get_ready_api_ready_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadyRead" } } }, "description": "Successful Response" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get Ready", "tags": [ "health" ] } }, "/api/v1/admins": { "get": { "description": "List the people who administer the organisation this key belongs to.\n\nReading is all this route offers: who administers this organisation is a decision made above\nit, so inviting and removing live under `/organisations/{id}/admins` and answer only for an\norganisation below this one.", "operationId": "list_own_organisation_admins_api_v1_admins_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_TenantAdminRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Organisation Admins", "tags": [ "organisation" ] } }, "/api/v1/ag-ui/runs": { "post": { "description": "Run one AG-UI run as a governed turn on the Core thread `threadId` names.\n\nAlways `200` and `text/event-stream` once admitted: `RUN_STARTED`, a `STATE_SNAPSHOT` of the\nthread's working state, the agent's messages and tool calls, then `RUN_FINISHED`, or\n`RUN_ERROR` when the turn failed. A run that ends with a frontend tool call finishes there;\nthe next run's `messages` carries its result.", "operationId": "create_run_api_v1_ag_ui_runs_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgUiRunAgentInput" } } }, "required": true }, "responses": { "200": { "content": { "text/event-stream": { "schema": { "description": "One AG-UI event of a run.", "oneOf": [ { "description": "The run has been admitted and its turn is running.", "properties": { "parentRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the run this one follows, echoed", "title": "Parentrunid" }, "runId": { "description": "the client's run id, echoed", "title": "Runid", "type": "string" }, "threadId": { "description": "the Core thread the run is on", "title": "Threadid", "type": "string" }, "type": { "const": "RUN_STARTED", "default": "RUN_STARTED", "description": "event kind", "title": "Type", "type": "string" } }, "required": [ "threadId", "runId" ], "title": "AgUiRunStartedEvent", "type": "object" }, { "description": "The run's turn ended and is recorded; the last event of a run that did not fail.", "properties": { "result": { "additionalProperties": true, "description": "`responseId`, the turn's `resp_` id for `GET /responses/{id}`, and `status`, the turn's own status", "title": "Result", "type": "object" }, "runId": { "description": "the client's run id, echoed", "title": "Runid", "type": "string" }, "threadId": { "description": "the Core thread the run is on", "title": "Threadid", "type": "string" }, "type": { "const": "RUN_FINISHED", "default": "RUN_FINISHED", "description": "event kind", "title": "Type", "type": "string" } }, "required": [ "threadId", "runId", "result" ], "title": "AgUiRunFinishedEvent", "type": "object" }, { "description": "The run's turn failed or could not be recorded; the last event of such a run.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Core's error code", "title": "Code" }, "message": { "description": "what went wrong, in Core's own fixed wording", "title": "Message", "type": "string" }, "type": { "const": "RUN_ERROR", "default": "RUN_ERROR", "description": "event kind", "title": "Type", "type": "string" } }, "required": [ "message" ], "title": "AgUiRunErrorEvent", "type": "object" }, { "description": "The agent has begun a text message.", "properties": { "messageId": { "description": "the Core item id of the message", "title": "Messageid", "type": "string" }, "role": { "const": "assistant", "default": "assistant", "description": "always the agent", "title": "Role", "type": "string" }, "type": { "const": "TEXT_MESSAGE_START", "default": "TEXT_MESSAGE_START", "description": "event kind", "title": "Type", "type": "string" } }, "required": [ "messageId" ], "title": "AgUiTextMessageStartEvent", "type": "object" }, { "description": "A piece of the message's text.", "properties": { "delta": { "description": "the piece, never empty", "minLength": 1, "title": "Delta", "type": "string" }, "messageId": { "description": "the message the piece belongs to", "title": "Messageid", "type": "string" }, "type": { "const": "TEXT_MESSAGE_CONTENT", "default": "TEXT_MESSAGE_CONTENT", "description": "event kind", "title": "Type", "type": "string" } }, "required": [ "messageId", "delta" ], "title": "AgUiTextMessageContentEvent", "type": "object" }, { "description": "The message is complete.", "properties": { "messageId": { "description": "the message that ended", "title": "Messageid", "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "on a message whose text cites a source only: `artific.annotations`, the message's annotations exactly as `output_text.annotations` carries them, offsets in Unicode code points into the whole text", "title": "Metadata" }, "type": { "const": "TEXT_MESSAGE_END", "default": "TEXT_MESSAGE_END", "description": "event kind", "title": "Type", "type": "string" } }, "required": [ "messageId" ], "title": "AgUiTextMessageEndEvent", "type": "object" }, { "description": "The agent called a tool: a frontend tool the client runs, or one Core runs itself.", "properties": { "toolCallId": { "description": "the call's id", "title": "Toolcallid", "type": "string" }, "toolCallName": { "description": "the tool's name", "title": "Toolcallname", "type": "string" }, "type": { "const": "TOOL_CALL_START", "default": "TOOL_CALL_START", "description": "event kind", "title": "Type", "type": "string" } }, "required": [ "toolCallId", "toolCallName" ], "title": "AgUiToolCallStartEvent", "type": "object" }, { "description": "The call's arguments, whole: Core sends them once the call is complete.", "properties": { "delta": { "description": "the call's arguments as JSON text", "title": "Delta", "type": "string" }, "toolCallId": { "description": "the call the arguments belong to", "title": "Toolcallid", "type": "string" }, "type": { "const": "TOOL_CALL_ARGS", "default": "TOOL_CALL_ARGS", "description": "event kind", "title": "Type", "type": "string" } }, "required": [ "toolCallId", "delta" ], "title": "AgUiToolCallArgsEvent", "type": "object" }, { "description": "The call is complete.", "properties": { "toolCallId": { "description": "the call that ended", "title": "Toolcallid", "type": "string" }, "type": { "const": "TOOL_CALL_END", "default": "TOOL_CALL_END", "description": "event kind", "title": "Type", "type": "string" } }, "required": [ "toolCallId" ], "title": "AgUiToolCallEndEvent", "type": "object" }, { "description": "The result of a call Core ran itself. A frontend tool's result is the client's own.", "properties": { "content": { "description": "the result as text", "title": "Content", "type": "string" }, "messageId": { "description": "the Core item id of the result", "title": "Messageid", "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "on a call that failed at Core: `error` true and `code`, the code Core recorded for the failure, such as `denied_by_policy` or `timeout`; on a result that read sources: `artific.citations`, the sources as `function_call_output.citations` carries them. Absent when neither applies", "title": "Metadata" }, "role": { "const": "tool", "default": "tool", "description": "always a tool", "title": "Role", "type": "string" }, "toolCallId": { "description": "the call it answers", "title": "Toolcallid", "type": "string" }, "type": { "const": "TOOL_CALL_RESULT", "default": "TOOL_CALL_RESULT", "description": "event kind", "title": "Type", "type": "string" } }, "required": [ "messageId", "toolCallId", "content" ], "title": "AgUiToolCallResultEvent", "type": "object" }, { "description": "The model has begun reasoning.", "properties": { "messageId": { "description": "the Core item id of the reasoning", "title": "Messageid", "type": "string" }, "type": { "const": "REASONING_START", "default": "REASONING_START", "description": "event kind", "title": "Type", "type": "string" } }, "required": [ "messageId" ], "title": "AgUiReasoningStartEvent", "type": "object" }, { "description": "The reasoning summary the model streams begins.", "properties": { "messageId": { "description": "the Core item id of the reasoning", "title": "Messageid", "type": "string" }, "role": { "const": "reasoning", "default": "reasoning", "description": "always reasoning", "title": "Role", "type": "string" }, "type": { "const": "REASONING_MESSAGE_START", "default": "REASONING_MESSAGE_START", "description": "event kind", "title": "Type", "type": "string" } }, "required": [ "messageId" ], "title": "AgUiReasoningMessageStartEvent", "type": "object" }, { "description": "A piece of the reasoning summary.", "properties": { "delta": { "description": "the piece, never empty", "minLength": 1, "title": "Delta", "type": "string" }, "messageId": { "description": "the reasoning the piece belongs to", "title": "Messageid", "type": "string" }, "type": { "const": "REASONING_MESSAGE_CONTENT", "default": "REASONING_MESSAGE_CONTENT", "description": "event kind", "title": "Type", "type": "string" } }, "required": [ "messageId", "delta" ], "title": "AgUiReasoningMessageContentEvent", "type": "object" }, { "description": "The reasoning summary is complete.", "properties": { "messageId": { "description": "the reasoning that ended", "title": "Messageid", "type": "string" }, "type": { "const": "REASONING_MESSAGE_END", "default": "REASONING_MESSAGE_END", "description": "event kind", "title": "Type", "type": "string" } }, "required": [ "messageId" ], "title": "AgUiReasoningMessageEndEvent", "type": "object" }, { "description": "The model has stopped reasoning.", "properties": { "messageId": { "description": "the reasoning that ended", "title": "Messageid", "type": "string" }, "type": { "const": "REASONING_END", "default": "REASONING_END", "description": "event kind", "title": "Type", "type": "string" } }, "required": [ "messageId" ], "title": "AgUiReasoningEndEvent", "type": "object" }, { "description": "The thread's working state, whole: sent when the run starts.", "properties": { "snapshot": { "description": "the working state object, or the string `[sealed]` for a state whose words a publication withholds", "title": "Snapshot" }, "type": { "const": "STATE_SNAPSHOT", "default": "STATE_SNAPSHOT", "description": "event kind", "title": "Type", "type": "string" } }, "required": [ "snapshot" ], "title": "AgUiStateSnapshotEvent", "type": "object" }, { "description": "What one of the model's working-state updates changed, as JSON Patch (RFC 6902).", "properties": { "delta": { "description": "the RFC 6902 operations, in order", "items": { "additionalProperties": true, "type": "object" }, "title": "Delta", "type": "array" }, "type": { "const": "STATE_DELTA", "default": "STATE_DELTA", "description": "event kind", "title": "Type", "type": "string" } }, "required": [ "delta" ], "title": "AgUiStateDeltaEvent", "type": "object" } ], "title": "AgUiEvent" } } }, "description": "the run's AG-UI events" }, "400": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem400", "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Run", "tags": [ "ag-ui" ] } }, "/api/v1/agents": { "get": { "description": "List the calling key's tenant's agents, each with its latest version.", "operationId": "list_agents_api_v1_agents_get", "parameters": [ { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "name", "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AgentRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Agents", "tags": [ "agents" ] }, "post": { "description": "Create an agent and its first version, decided as a `write` for the person the request\nnames.", "operationId": "create_agent_api_v1_agents_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Agent", "tags": [ "agents" ] } }, "/api/v1/agents/{agent_id}": { "delete": { "description": "Delete an agent and all its versions, decided for the person the request names.", "operationId": "delete_agent_api_v1_agents__agent_id__delete", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Agent", "tags": [ "agents" ] }, "get": { "description": "Fetch one agent with its latest version.", "operationId": "get_agent_api_v1_agents__agent_id__get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Agent", "tags": [ "agents" ] } }, "/api/v1/agents/{agent_id}/checks/summary": { "get": { "description": "Per check name how many results of this agent's turns passed, failed or errored since\n`since`. Counts only, never a reason or text.", "operationId": "get_agent_check_summary_api_v1_agents__agent_id__checks_summary_get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "description": "Start of the window; default 7 days ago, at most 90 days back", "in": "query", "name": "since", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Start of the window; default 7 days ago, at most 90 days back", "title": "Since" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckSummary" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Agent Check Summary", "tags": [ "responses" ] } }, "/api/v1/agents/{agent_id}/copy": { "post": { "description": "Create a new agent from one published version of this one, decided as a read of this agent\nand a create of the new one for the person the request names.", "operationId": "copy_agent_api_v1_agents__agent_id__copy_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentCopyCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Copy Agent", "tags": [ "agents" ] } }, "/api/v1/agents/{agent_id}/cover": { "delete": { "description": "Remove the picture on one agent.", "operationId": "delete_agent_cover_api_v1_agents__agent_id__cover_delete", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Agent Cover", "tags": [ "covers" ] }, "get": { "description": "The cover of one agent, as bytes -- the picture its `agent__` tool shows.", "operationId": "get_agent_cover_api_v1_agents__agent_id__cover_get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } } }, "description": "The cover image." }, "304": { "description": "The caller's copy is current." }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Agent Cover", "tags": [ "covers" ] }, "put": { "description": "Put a picture on one agent.", "operationId": "set_agent_cover_api_v1_agents__agent_id__cover_put", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "The image itself, as the whole body: a PNG, a JPEG or a WebP. Send its own type as `Content-Type` -- what decides acceptance is the bytes, not the header.", "required": true }, "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "415": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem415", "type": "object" } } }, "description": "Unsupported Media Type" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Set Agent Cover", "tags": [ "covers" ] } }, "/api/v1/agents/{agent_id}/versions": { "get": { "description": "List an agent's versions, oldest first, or newest first\nwith `order=desc`; cursor = version number.", "operationId": "list_versions_api_v1_agents__agent_id__versions_get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "in": "query", "name": "order", "required": false, "schema": { "default": "asc", "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "enum": [ "asc", "desc" ], "title": "Order", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AgentVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Versions", "tags": [ "agents" ] }, "post": { "description": "Add a new version to an agent, decided as a `write` for the person the request names.", "operationId": "create_version_api_v1_agents__agent_id__versions_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentVersionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Version", "tags": [ "agents" ] } }, "/api/v1/agents/{agent_id}/versions/{version}": { "get": { "description": "Fetch one specific version of an agent.", "operationId": "get_version_api_v1_agents__agent_id__versions__version__get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Version", "tags": [ "agents" ] } }, "/api/v1/api_connectors": { "get": { "description": "List the calling key's tenant's API connectors.", "operationId": "list_api_connectors_api_v1_api_connectors_get", "parameters": [ { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "name", "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ApiConnectorRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Api Connectors", "tags": [ "api connectors" ] }, "post": { "description": "Register an API connector under the calling key's tenant. 503 when the body carries a\ncredential and the deployment configures no key to seal it with.", "operationId": "create_api_connector_api_v1_api_connectors_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiConnectorCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiConnectorRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Api Connector", "tags": [ "api connectors" ] } }, "/api/v1/api_connectors/{connector_id}": { "delete": { "description": "Delete an API connector; its versions cascade at the database.", "operationId": "delete_api_connector_api_v1_api_connectors__connector_id__delete", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Api Connector", "tags": [ "api connectors" ] }, "get": { "description": "Fetch one API connector.", "operationId": "get_api_connector_api_v1_api_connectors__connector_id__get", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiConnectorRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Api Connector", "tags": [ "api connectors" ] }, "patch": { "description": "Update what this connector does, or its credential. A change to the description, the\nargument schema, the endpoint or the request creates the next version; a body naming only\n`auth` creates none. `name` never changes.", "operationId": "update_api_connector_api_v1_api_connectors__connector_id__patch", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiConnectorUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiConnectorRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Api Connector", "tags": [ "api connectors" ] } }, "/api/v1/api_connectors/{connector_id}/authorizations": { "post": { "description": "Ask Core for the URL this person opens to connect their own login to this connector. 409\nwhen the connector's credential is not a person's own login; 503 when this deployment\nconfigures no public address to send them back to.", "operationId": "begin_api_connector_authorization_api_v1_api_connectors__connector_id__authorizations_post", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationUrlRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Begin Api Connector Authorization", "tags": [ "api connectors" ] } }, "/api/v1/api_connectors/{connector_id}/authorizations/{user}": { "delete": { "description": "Forget this person's grant at this connector. Core's own copy only; the provider is never\ntold, and a person with no grant answers 204 just the same.", "operationId": "revoke_api_connector_authorization_api_v1_api_connectors__connector_id__authorizations__user__delete", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "the calling application's own opaque identifier of the person, the same value its `POST /responses` sends as `user`", "in": "path", "name": "user", "required": true, "schema": { "description": "the calling application's own opaque identifier of the person, the same value its `POST /responses` sends as `user`", "pattern": "^[A-Za-z0-9._:@-]{1,128}$", "title": "User", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Revoke Api Connector Authorization", "tags": [ "api connectors" ] }, "get": { "description": "Whether this person has connected their login to this connector, and what it covers.", "operationId": "get_api_connector_authorization_api_v1_api_connectors__connector_id__authorizations__user__get", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "the calling application's own opaque identifier of the person, the same value its `POST /responses` sends as `user`", "in": "path", "name": "user", "required": true, "schema": { "description": "the calling application's own opaque identifier of the person, the same value its `POST /responses` sends as `user`", "pattern": "^[A-Za-z0-9._:@-]{1,128}$", "title": "User", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Api Connector Authorization", "tags": [ "api connectors" ] } }, "/api/v1/api_connectors/{connector_id}/versions": { "get": { "description": "List one connector's versions, newest first (`order=asc` reverses it); the cursor is a\nversion number.", "operationId": "list_api_connector_versions_api_v1_api_connectors__connector_id__versions_get", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "keyset direction: 'desc' (newest first, the default) or 'asc'", "in": "query", "name": "order", "required": false, "schema": { "default": "desc", "description": "keyset direction: 'desc' (newest first, the default) or 'asc'", "enum": [ "asc", "desc" ], "title": "Order", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ApiConnectorVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Api Connector Versions", "tags": [ "api connectors" ] } }, "/api/v1/api_connectors/{connector_id}/versions/{version}": { "get": { "description": "Fetch one version of a connector.", "operationId": "get_api_connector_version_api_v1_api_connectors__connector_id__versions__version__get", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiConnectorVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Api Connector Version", "tags": [ "api connectors" ] } }, "/api/v1/artifacts": { "get": { "description": "List the calling key's tenant's artifacts, optionally narrowed to one response or to a\n`folder` (with the folders beneath it unless `recursive` is false); `trashed` lists the\ntrash instead.", "operationId": "list_artifacts_api_v1_artifacts_get", "parameters": [ { "description": "narrow to one response id", "in": "query", "name": "response_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one response id", "title": "Response Id" } }, { "description": "only rows in this folder and, unless `recursive` is false, beneath it, matched by whole path segments; an empty value names the root", "in": "query", "name": "folder", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "only rows in this folder and, unless `recursive` is false, beneath it, matched by whole path segments; an empty value names the root", "title": "Folder" } }, { "description": "whether rows in folders beneath `folder` count (the default); false returns the folder's own rows only", "in": "query", "name": "recursive", "required": false, "schema": { "default": true, "description": "whether rows in folders beneath `folder` count (the default); false returns the folder's own rows only", "title": "Recursive", "type": "boolean" } }, { "description": "list the rows in the trash instead of the live ones, each with when it was deleted and when it is purged; false (the default) lists the live rows", "in": "query", "name": "trashed", "required": false, "schema": { "default": false, "description": "list the rows in the trash instead of the live ones, each with when it was deleted and when it is purged; false (the default) lists the live rows", "title": "Trashed", "type": "boolean" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ArtifactRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Artifacts", "tags": [ "artifacts" ] } }, "/api/v1/artifacts/{artifact_id}": { "delete": { "description": "Delete an artifact into the trash: gone from every read at once, its bytes kept for\n`files_trash_days`. An artifact already in the trash is purged at once, with its bytes.", "operationId": "delete_artifact_api_v1_artifacts__artifact_id__delete", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Artifact", "tags": [ "artifacts" ] }, "get": { "description": "Fetch one artifact's metadata.", "operationId": "get_artifact_api_v1_artifacts__artifact_id__get", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Artifact", "tags": [ "artifacts" ] }, "patch": { "description": "Rename an artifact, move it and/or change its retention.", "operationId": "update_artifact_api_v1_artifacts__artifact_id__patch", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Artifact", "tags": [ "artifacts" ] } }, "/api/v1/artifacts/{artifact_id}/content": { "get": { "description": "Fetch an artifact's raw bytes as an attachment, gated on the calling key's data-egress\npolicy: a denial is `403` and recorded, an allowed download records the decision and the\nread.", "operationId": "get_artifact_content_api_v1_artifacts__artifact_id__content_get", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Artifact Content", "tags": [ "artifacts" ] } }, "/api/v1/artifacts/{artifact_id}/links": { "get": { "description": "List the share links on an artifact, oldest first. An expired link is listed with\n`expired: true` until it is revoked.", "operationId": "list_artifact_links_api_v1_artifacts__artifact_id__links_get", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ShareLinkRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Artifact Links", "tags": [ "artifacts" ] }, "post": { "description": "Share an HTML artifact through a link that opens it with no credential until it expires.\nSharing an artifact is downloading it, so the key's data-egress policy gates it first; then\n`403` unless the organisation's policy allows share links.", "operationId": "create_artifact_link_api_v1_artifacts__artifact_id__links_post", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ShareLinkCreate" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareLinkRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Artifact Link", "tags": [ "artifacts" ] } }, "/api/v1/artifacts/{artifact_id}/links/{link_id}": { "delete": { "description": "Revoke one share link on an artifact: its address stops opening the page at once.", "operationId": "revoke_artifact_link_api_v1_artifacts__artifact_id__links__link_id__delete", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "path", "name": "link_id", "required": true, "schema": { "title": "Link Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Revoke Artifact Link", "tags": [ "artifacts" ] }, "get": { "description": "Fetch one share link on an artifact.", "operationId": "get_artifact_link_api_v1_artifacts__artifact_id__links__link_id__get", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "path", "name": "link_id", "required": true, "schema": { "title": "Link Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareLinkRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Artifact Link", "tags": [ "artifacts" ] } }, "/api/v1/artifacts/{artifact_id}/restore": { "post": { "description": "Take an artifact out of the trash, back on every read, and ingest it anew. `404` for one\nnot in the trash.", "operationId": "restore_artifact_api_v1_artifacts__artifact_id__restore_post", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Restore Artifact", "tags": [ "artifacts" ] } }, "/api/v1/artifacts/{artifact_id}/view": { "post": { "description": "Mint a short-lived address that serves an HTML artifact as a page, gated on the calling\nkey's data-egress policy as a download is. `409` for an artifact that is not HTML.", "operationId": "view_artifact_api_v1_artifacts__artifact_id__view_post", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewTicketRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "View Artifact", "tags": [ "artifacts" ] } }, "/api/v1/assist": { "get": { "description": "Show which model this organisation's helpers call, and whether it is the organisation's\nown choice or the deployment's default -- or that there is none, when every helper answers\n`409`.", "operationId": "get_assist_api_v1_assist_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssistStatusRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Assist", "tags": [ "assist" ] } }, "/api/v1/assist/graph-schema": { "post": { "description": "Draft a knowledge graph's schema -- entity types and relation types, in the body\n`PUT /knowledge/graphs/{id}/schema` takes -- from a plain-language description, from a sample\nof a collection, or both. Nothing is stored.\n\nA named collection is read as any collection read is: under this key's rules over\n`knowledge_collection` (`404` for one it does not reach, or when the key does not hold\n`knowledge`) and for the person `X-Core-Subject` names, so the model is shown only sources that\nperson may read. The sample is the most recent sources, at most five, each cut to 4,000\ncharacters, and the answer lists the ones it read. Then one call to the organisation's helper\nmodel, decided under this key's policy and its organisation's (`403`), refused at either\nmonthly cap (`429`), and metered as model tokens to this key. `409` when no helper model is\nconfigured; `503` when the model could not be reached, refused the request or did not\nanswer with a schema the schema route would store.", "operationId": "assist_graph_schema_api_v1_assist_graph_schema_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphSchemaAssistRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphSchemaAssistRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Assist Graph Schema", "tags": [ "assist" ] } }, "/api/v1/assist/json-schema": { "post": { "description": "Write a JSON Schema from a plain-language description, optionally changing a schema the\ncaller already has, and say in a few sentences what it requires. Nothing is stored.\n\nOne call to the organisation's helper model, decided under this key's policy and its\norganisation's (`403` when either refuses the model or where it runs), refused at either\nmonthly cap (`429`), and metered as model tokens to this key. `409` when no helper model is\nconfigured; `503` when the model could not be reached, refused the request or did not\nanswer with a usable schema.", "operationId": "assist_json_schema_api_v1_assist_json_schema_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonSchemaAssistRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonSchemaAssistRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Assist Json Schema", "tags": [ "assist" ] } }, "/api/v1/audio/speech": { "post": { "description": "Speak one text with a catalogue model of kind `speech`, and answer the audio itself.\n\nRefused before any vendor is dialled: `403` for a key that hides personal data or whose\npolicy refuses the model, `422` on the field that does not fit the model, `429` at a monthly\ncap. The text's characters are billed as one `speech_synthesis` row once the vendor accepts\nthe call, before the first byte is relayed; a stream the vendor cuts short stays billed.", "operationId": "create_speech_api_v1_audio_speech_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeechCreate" } } }, "required": true }, "responses": { "200": { "content": { "audio/flac": { "schema": { "format": "binary", "type": "string" } }, "audio/mpeg": { "schema": { "format": "binary", "type": "string" } }, "audio/ogg": { "schema": { "format": "binary", "type": "string" } }, "audio/pcm": { "schema": { "format": "binary", "type": "string" } }, "audio/wav": { "schema": { "format": "binary", "type": "string" } } }, "description": "the audio, whole or streamed as the vendor sends it" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Speech", "tags": [ "audio" ] } }, "/api/v1/audio/transcription-jobs": { "get": { "description": "This key's transcription jobs, newest first; for a credential bound to one person, only\nthat person's.", "operationId": "list_transcription_jobs_api_v1_audio_transcription_jobs_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_TranscriptionJobRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Transcription Jobs", "tags": [ "audio" ] }, "post": { "description": "Transcribe an uploaded recording longer than one vendor call takes, in the background.\n\nCore splits it into chunks its model's vendor takes, transcribes them one after another and\njoins their text, with one segment per chunk. `422` on `model` for a model that is not an\naudio model of this organisation, `422` on `file_id` for a file this key cannot read or whose\nbytes are not a recording, `403` when the key's policy refuses the model, `429` when a cap is\nreached or the whole recording's estimated cost would cross it. Every chunk a vendor answered\nbills one `audio_transcription` row. Poll `Location` until the status is `completed`,\n`failed` or `cancelled`.", "operationId": "create_transcription_job_api_v1_audio_transcription_jobs_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscriptionJobCreate" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscriptionJobRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Transcription Job", "tags": [ "audio" ] } }, "/api/v1/audio/transcription-jobs/{job_id}": { "get": { "description": "One transcription job: its status, how many chunks are done and, once completed, the\ntranscript with one segment per chunk.", "operationId": "get_transcription_job_api_v1_audio_transcription_jobs__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscriptionJobRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Transcription Job", "tags": [ "audio" ] } }, "/api/v1/audio/transcription-jobs/{job_id}/cancel": { "post": { "description": "Stop a queued or running job: the chunks already done stay billed and kept, and no\nfurther chunk is sent. A job already ended is answered as it stands.", "operationId": "cancel_transcription_job_api_v1_audio_transcription_jobs__job_id__cancel_post", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscriptionJobRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Cancel Transcription Job", "tags": [ "audio" ] } }, "/api/v1/audio/transcriptions": { "post": { "description": "Transcribe one recording with a catalogue model of kind `audio`.\n\nThe recording goes to the model's vendor as it is: audio cannot be pseudonymised, so where\nthat vendor runs is decided by the key's policy before anything is sent, and refused `403`.\nThe format is read off the recording's own bytes -- flac, mp3, mp4, mpeg, mpga, m4a, ogg,\noga, wav or webm -- never off its name; anything else is `422` on `file`. One recording is at\nmost the key's file ceiling (`files_max_bytes`, 25 MiB by default), `413` above it. The key's\nmonthly cap is asked before the vendor is dialled (`429`), and every transcription the\nvendor answered bills its whole seconds -- or, for a model billed in tokens, its tokens -- as\none `audio_transcription` row.", "operationId": "create_transcription_api_v1_audio_transcriptions_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_create_transcription_api_v1_audio_transcriptions_post" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TranscriptionRead" }, { "$ref": "#/components/schemas/TranscriptionVerboseRead" } ], "title": "Response Create Transcription Api V1 Audio Transcriptions Post" } }, "text/plain": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Transcription", "tags": [ "audio" ] } }, "/api/v1/audit/events": { "get": { "description": "List the audit events the calling key's own requests wrote, minus the resource denials that\nwould name what this key's own policy withholds (`app.audit.service.list_events`).", "operationId": "list_own_audit_events_api_v1_audit_events_get", "parameters": [ { "description": "narrow to one request id", "in": "query", "name": "request_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one request id", "title": "Request Id" } }, { "description": "narrow to one response id", "in": "query", "name": "response_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one response id", "title": "Response Id" } }, { "description": "narrow to one event name", "in": "query", "name": "event", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one event name", "title": "Event" } }, { "description": "narrow to the rows written for one person, by the id the calling application named them with; exact match, never a prefix", "in": "query", "name": "subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to the rows written for one person, by the id the calling application named them with; exact match, never a prefix", "title": "Subject" } }, { "description": "narrow to the events Core recorded itself (`core`) or to those a product built on Core delivered (`product`)", "in": "query", "name": "origin", "required": false, "schema": { "anyOf": [ { "enum": [ "core", "product" ], "type": "string" }, { "type": "null" } ], "description": "narrow to the events Core recorded itself (`core`) or to those a product built on Core delivered (`product`)", "title": "Origin" } }, { "description": "narrow to the events one product delivered, by its namespace", "in": "query", "name": "product", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z][a-z0-9]{1,15}$", "type": "string" }, { "type": "null" } ], "description": "narrow to the events one product delivered, by its namespace", "title": "Product" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "in": "query", "name": "order", "required": false, "schema": { "default": "asc", "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "enum": [ "asc", "desc" ], "title": "Order", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AuditEventRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Audit Events", "tags": [ "audit" ] }, "post": { "description": "Deliver a product's own events to this key's organisation's audit trail, beside Core's\nown: one to a hundred, recorded together or not at all, each in the product namespace an\noperator set on this organisation or the nearest one above it.\n\nIdempotent by each event's `id`: delivering one again keeps the row already recorded and\nanswers `created: false`. Deliver only what Core does not record itself -- never a call, a\ntool run or a key change. A subject token is refused `403`\n(`docs/architecture/audit-and-metering.md#product-events`).", "operationId": "append_product_events_api_v1_audit_events_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductEventsCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductEventsAccepted" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Append Product Events", "tags": [ "audit" ] } }, "/api/v1/audit/events/export": { "get": { "description": "Stream the calling key's own audit trail as JSON Lines, oldest first, with the same\nfilters the list takes and the same resource denials withheld\n(`app.audit.service.list_events`).\n\nA whole-organisation export, for retention or a SIEM, is\n`GET /organisations/{organisation_id}/audit/events/export` for a key holding `management`\n(`docs/architecture/audit-and-metering.md#export`).", "operationId": "export_own_audit_events_api_v1_audit_events_export_get", "parameters": [ { "description": "resume after this audit event: the `id` on the last whole line a broken download delivered; only later rows are sent", "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "resume after this audit event: the `id` on the last whole line a broken download delivered; only later rows are sent", "title": "After" } }, { "description": "narrow to one request id", "in": "query", "name": "request_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one request id", "title": "Request Id" } }, { "description": "narrow to one response id", "in": "query", "name": "response_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one response id", "title": "Response Id" } }, { "description": "narrow to one event name", "in": "query", "name": "event", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one event name", "title": "Event" } }, { "description": "narrow to the rows written for one person, by the id the calling application named them with; exact match, never a prefix", "in": "query", "name": "subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to the rows written for one person, by the id the calling application named them with; exact match, never a prefix", "title": "Subject" } }, { "description": "narrow to the events Core recorded itself (`core`) or to those a product built on Core delivered (`product`)", "in": "query", "name": "origin", "required": false, "schema": { "anyOf": [ { "enum": [ "core", "product" ], "type": "string" }, { "type": "null" } ], "description": "narrow to the events Core recorded itself (`core`) or to those a product built on Core delivered (`product`)", "title": "Origin" } }, { "description": "narrow to the events one product delivered, by its namespace", "in": "query", "name": "product", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z][a-z0-9]{1,15}$", "type": "string" }, { "type": "null" } ], "description": "narrow to the events one product delivered, by its namespace", "title": "Product" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "application/x-ndjson": { "schema": { "description": "One AuditEventRead object per line, oldest first, as JSON Lines.", "title": "AuditEventExport", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Export Own Audit Events", "tags": [ "audit" ] } }, "/api/v1/available-publications": { "get": { "description": "List what this key's own organisation may install.", "operationId": "list_own_available_publications_api_v1_available_publications_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_PublicationRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Available Publications", "tags": [ "sharing" ] } }, "/api/v1/available-publications/{publication_id}": { "get": { "description": "Show one publication this key's own organisation may install.", "operationId": "get_own_available_publication_api_v1_available_publications__publication_id__get", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailablePublicationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Available Publication", "tags": [ "sharing" ] } }, "/api/v1/available-publications/{publication_id}/cover": { "get": { "description": "The listing cover of one publication this key's own organisation may install.", "operationId": "get_own_available_publication_cover_api_v1_available_publications__publication_id__cover_get", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } } }, "description": "The cover image." }, "304": { "description": "The caller's copy is current." }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Available Publication Cover", "tags": [ "sharing" ] } }, "/api/v1/computer-egress": { "get": { "description": "List the connections this organisation's computers opened through Core's egress proxy,\nnewest first, narrowed by host and by when they opened.", "operationId": "list_organisation_egress_api_v1_computer_egress_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "only connections to this host, in any spelling", "in": "query", "name": "host", "required": false, "schema": { "anyOf": [ { "maxLength": 253, "type": "string" }, { "type": "null" } ], "description": "only connections to this host, in any spelling", "title": "Host" } }, { "description": "only connections opened at or after this instant", "in": "query", "name": "opened_after", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only connections opened at or after this instant", "title": "Opened After" } }, { "description": "only connections opened before this instant", "in": "query", "name": "opened_before", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only connections opened before this instant", "title": "Opened Before" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ComputerEgressObject_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Organisation Egress", "tags": [ "computers" ] } }, "/api/v1/computers": { "get": { "description": "List this organisation's computers, newest first.", "operationId": "list_computers_api_v1_computers_get", "parameters": [ { "description": "'live', the default, for the computers that may still exist at their provider; 'all' for every one this organisation's turns made", "in": "query", "name": "status", "required": false, "schema": { "default": "live", "description": "'live', the default, for the computers that may still exist at their provider; 'all' for every one this organisation's turns made", "enum": [ "live", "all" ], "title": "Status", "type": "string" } }, { "description": "only the computers this response's turn made", "in": "query", "name": "response_id", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "only the computers this response's turn made", "title": "Response Id" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ComputerObject_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Computers", "tags": [ "computers" ] } }, "/api/v1/computers/{computer_id}": { "delete": { "description": "Destroy one of this organisation's live computers now. The turn holding it finds it gone\non its next call; the sandbox-seconds it ran are billed to the caller.", "operationId": "destroy_computer_api_v1_computers__computer_id__delete", "parameters": [ { "in": "path", "name": "computer_id", "required": true, "schema": { "title": "Computer Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Destroy Computer", "tags": [ "computers" ] }, "get": { "description": "Fetch one of this organisation's computers.", "operationId": "get_computer_api_v1_computers__computer_id__get", "parameters": [ { "in": "path", "name": "computer_id", "required": true, "schema": { "title": "Computer Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputerObject" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Computer", "tags": [ "computers" ] } }, "/api/v1/computers/{computer_id}/egress": { "get": { "description": "List the connections one of this organisation's computers opened through Core's egress\nproxy, newest first. Traffic that did not use the proxy is not here.", "operationId": "list_computer_egress_api_v1_computers__computer_id__egress_get", "parameters": [ { "in": "path", "name": "computer_id", "required": true, "schema": { "title": "Computer Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "only connections to this host, in any spelling", "in": "query", "name": "host", "required": false, "schema": { "anyOf": [ { "maxLength": 253, "type": "string" }, { "type": "null" } ], "description": "only connections to this host, in any spelling", "title": "Host" } }, { "description": "only connections opened at or after this instant", "in": "query", "name": "opened_after", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only connections opened at or after this instant", "title": "Opened After" } }, { "description": "only connections opened before this instant", "in": "query", "name": "opened_before", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only connections opened before this instant", "title": "Opened Before" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ComputerEgressObject_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Computer Egress", "tags": [ "computers" ] } }, "/api/v1/control-events": { "get": { "description": "List this organisation's lifecycle events: organisations and keys created, updated,\nrotated and deleted, and who did each of them.\n\nA parent that has reserved this organisation's audit trail to itself has not reserved this:\nan organisation's own lifecycle is the one record it always keeps\n(`docs/architecture/tenancy.md` \"What a parent reserves to itself\").", "operationId": "list_organisation_control_events_api_v1_control_events_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "in": "query", "name": "order", "required": false, "schema": { "default": "asc", "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "enum": [ "asc", "desc" ], "title": "Order", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ControlEventRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Organisation Control Events", "tags": [ "organisation" ] } }, "/api/v1/datastores": { "get": { "description": "List the organisation's datastores this key reaches, oldest first.", "operationId": "list_datastores_api_v1_datastores_get", "parameters": [ { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "name", "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_DatastoreRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Datastores", "tags": [ "datastores" ] }, "post": { "description": "Create a datastore, with its first schema version when the body carries one.", "operationId": "create_datastore_api_v1_datastores_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Datastore", "tags": [ "datastores" ] } }, "/api/v1/datastores/batch": { "post": { "description": "Apply up to a hundred puts, deletes and counter numbers across the organisation's\ndatastores all together or not at all, each checked as its single route checks it. A refusal\nnames the operation by its index and nothing of the batch is written.", "operationId": "apply_datastore_batch_api_v1_datastores_batch_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreBatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreBatchRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "412": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem412", "type": "object" } } }, "description": "Precondition Failed" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a `422` a datastore's write function answered: its own reason, or how\na run that decided nothing ended, beside the `errors` every other `422` of the route carries\n(`docs/architecture/datastores.md#a-write-function`). A subclass, as `ConflictProblem` is, so\none route declares both shapes at once.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "how a run of the write function that decided nothing ended -- `trapped`, `fuel_exhausted`, `memory_exceeded`, `timeout`, `invalid_arguments`, `invalid_response` or `executor_failed`; null for a refusal", "title": "Error Code" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "refusal": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "why the write function refused the write, in the organisation's own words, at most 500 characters; null when it did not refuse", "title": "Refusal" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "WriteRefusedProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Apply Datastore Batch", "tags": [ "datastores" ] } }, "/api/v1/datastores/{datastore_id}": { "delete": { "description": "Delete a datastore with its schema versions and records; `409` while another datastore's\nlatest schema version declares a reference into it, or while it is retained for bookkeeping.", "operationId": "delete_datastore_api_v1_datastores__datastore_id__delete", "parameters": [ { "in": "path", "name": "datastore_id", "required": true, "schema": { "title": "Datastore Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Datastore", "tags": [ "datastores" ] }, "get": { "description": "Fetch one datastore.", "operationId": "get_datastore_api_v1_datastores__datastore_id__get", "parameters": [ { "in": "path", "name": "datastore_id", "required": true, "schema": { "title": "Datastore Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Datastore", "tags": [ "datastores" ] }, "patch": { "description": "Change a datastore's description, metadata or expiry; its name never changes.", "operationId": "update_datastore_api_v1_datastores__datastore_id__patch", "parameters": [ { "in": "path", "name": "datastore_id", "required": true, "schema": { "title": "Datastore Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Datastore", "tags": [ "datastores" ] } }, "/api/v1/datastores/{datastore_id}/counters/{name}/next": { "post": { "description": "Take the next number of a datastore's counter, 1 on first use: gapless, because a request\nthat fails gives its number back. `403` unless the key may `use` the datastore.", "operationId": "next_datastore_counter_api_v1_datastores__datastore_id__counters__name__next_post", "parameters": [ { "in": "path", "name": "datastore_id", "required": true, "schema": { "title": "Datastore Id", "type": "string" } }, { "description": "the counter's name within its datastore", "in": "path", "name": "name", "required": true, "schema": { "description": "the counter's name within its datastore", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$", "title": "Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreCounterRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Next Datastore Counter", "tags": [ "datastores" ] } }, "/api/v1/datastores/{datastore_id}/records": { "get": { "description": "List a datastore's records this request's person reaches, by key; cursor = key.", "operationId": "list_datastore_records_api_v1_datastores__datastore_id__records_get", "parameters": [ { "in": "path", "name": "datastore_id", "required": true, "schema": { "title": "Datastore Id", "type": "string" } }, { "description": "only records whose key starts with this", "in": "query", "name": "key_prefix", "required": false, "schema": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "description": "only records whose key starts with this", "title": "Key Prefix" } }, { "description": "only records whose metadata carries this `name:value` string pair; repeat the parameter to require several, which are read as *and*", "in": "query", "name": "metadata", "required": false, "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "only records whose metadata carries this `name:value` string pair; repeat the parameter to require several, which are read as *and*", "title": "Metadata" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_DatastoreRecordRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Datastore Records", "tags": [ "datastores" ] }, "post": { "description": "Write a new record under a key Core generates.", "operationId": "create_datastore_record_api_v1_datastores__datastore_id__records_post", "parameters": [ { "in": "path", "name": "datastore_id", "required": true, "schema": { "title": "Datastore Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreRecordWrite" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreRecordRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a `422` a datastore's write function answered: its own reason, or how\na run that decided nothing ended, beside the `errors` every other `422` of the route carries\n(`docs/architecture/datastores.md#a-write-function`). A subclass, as `ConflictProblem` is, so\none route declares both shapes at once.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "how a run of the write function that decided nothing ended -- `trapped`, `fuel_exhausted`, `memory_exceeded`, `timeout`, `invalid_arguments`, `invalid_response` or `executor_failed`; null for a refusal", "title": "Error Code" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "refusal": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "why the write function refused the write, in the organisation's own words, at most 500 characters; null when it did not refuse", "title": "Refusal" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "WriteRefusedProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Datastore Record", "tags": [ "datastores" ] } }, "/api/v1/datastores/{datastore_id}/records/query": { "post": { "description": "Query a datastore's records this request's person reaches: filtered on fields of `data`,\non the key and on the two timestamps, sorted on one field. `422` naming the field for a\nfilter its field cannot carry, and for a query that ran past its time budget.", "operationId": "query_datastore_records_api_v1_datastores__datastore_id__records_query_post", "parameters": [ { "in": "path", "name": "datastore_id", "required": true, "schema": { "title": "Datastore Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor, for the same sort", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor, for the same sort", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreRecordQuery" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_DatastoreRecordRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Query Datastore Records", "tags": [ "datastores" ] } }, "/api/v1/datastores/{datastore_id}/records/{key}": { "delete": { "description": "Delete one record; `412` when `If-Match` names a version it is no longer at. A record\npointing at it keeps its pointer, which then reads dangling.", "operationId": "delete_datastore_record_api_v1_datastores__datastore_id__records__key__delete", "parameters": [ { "in": "path", "name": "datastore_id", "required": true, "schema": { "title": "Datastore Id", "type": "string" } }, { "description": "the record's key within its datastore", "in": "path", "name": "key", "required": true, "schema": { "description": "the record's key within its datastore", "pattern": "^[A-Za-z0-9_.:-]{1,128}$", "title": "Key", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } }, { "description": "the `ETag` of the record as this write's caller read it, or a comma-separated list of them; `*` is met by any record under the key. When the record carries none of them -- written or deleted since -- the write is refused with 412 and changes nothing. Compared strongly: a weak tag never matches. Left out, the write is not held to a version", "in": "header", "name": "If-Match", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the `ETag` of the record as this write's caller read it, or a comma-separated list of them; `*` is met by any record under the key. When the record carries none of them -- written or deleted since -- the write is refused with 412 and changes nothing. Compared strongly: a weak tag never matches. Left out, the write is not held to a version", "title": "If-Match" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "412": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem412", "type": "object" } } }, "description": "Precondition Failed" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a `422` a datastore's write function answered: its own reason, or how\na run that decided nothing ended, beside the `errors` every other `422` of the route carries\n(`docs/architecture/datastores.md#a-write-function`). A subclass, as `ConflictProblem` is, so\none route declares both shapes at once.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "how a run of the write function that decided nothing ended -- `trapped`, `fuel_exhausted`, `memory_exceeded`, `timeout`, `invalid_arguments`, `invalid_response` or `executor_failed`; null for a refusal", "title": "Error Code" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "refusal": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "why the write function refused the write, in the organisation's own words, at most 500 characters; null when it did not refuse", "title": "Refusal" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "WriteRefusedProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Datastore Record", "tags": [ "datastores" ] }, "get": { "description": "Fetch one record by its key; `ETag` names it at the revision read.", "operationId": "get_datastore_record_api_v1_datastores__datastore_id__records__key__get", "parameters": [ { "in": "path", "name": "datastore_id", "required": true, "schema": { "title": "Datastore Id", "type": "string" } }, { "description": "the record's key within its datastore", "in": "path", "name": "key", "required": true, "schema": { "description": "the record's key within its datastore", "pattern": "^[A-Za-z0-9_.:-]{1,128}$", "title": "Key", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreRecordRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Datastore Record", "tags": [ "datastores" ] }, "put": { "description": "Write the record under `key`, replacing it whole when it exists. `201` with a `Location`\nwhen it did not, `200` when it did; `412` when `If-Match` or `If-None-Match` does not hold.", "operationId": "put_datastore_record_api_v1_datastores__datastore_id__records__key__put", "parameters": [ { "in": "path", "name": "datastore_id", "required": true, "schema": { "title": "Datastore Id", "type": "string" } }, { "description": "the record's key within its datastore", "in": "path", "name": "key", "required": true, "schema": { "description": "the record's key within its datastore", "pattern": "^[A-Za-z0-9_.:-]{1,128}$", "title": "Key", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } }, { "description": "the `ETag` of the record as this write's caller read it, or a comma-separated list of them; `*` is met by any record under the key. When the record carries none of them -- written or deleted since -- the write is refused with 412 and changes nothing. Compared strongly: a weak tag never matches. Left out, the write is not held to a version", "in": "header", "name": "If-Match", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the `ETag` of the record as this write's caller read it, or a comma-separated list of them; `*` is met by any record under the key. When the record carries none of them -- written or deleted since -- the write is refused with 412 and changes nothing. Compared strongly: a weak tag never matches. Left out, the write is not held to a version", "title": "If-Match" } }, { "description": "`*` to create the record only: when a record is already under the key the write is refused with 412 and changes nothing. No other value is taken", "in": "header", "name": "If-None-Match", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "`*` to create the record only: when a record is already under the key the write is refused with 412 and changes nothing. No other value is taken", "title": "If-None-Match" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreRecordWrite" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreRecordRead" } } }, "description": "Successful Response" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreRecordRead" } } }, "description": "Created" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "412": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem412", "type": "object" } } }, "description": "Precondition Failed" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a `422` a datastore's write function answered: its own reason, or how\na run that decided nothing ended, beside the `errors` every other `422` of the route carries\n(`docs/architecture/datastores.md#a-write-function`). A subclass, as `ConflictProblem` is, so\none route declares both shapes at once.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "how a run of the write function that decided nothing ended -- `trapped`, `fuel_exhausted`, `memory_exceeded`, `timeout`, `invalid_arguments`, `invalid_response` or `executor_failed`; null for a refusal", "title": "Error Code" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "refusal": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "why the write function refused the write, in the organisation's own words, at most 500 characters; null when it did not refuse", "title": "Refusal" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "WriteRefusedProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Put Datastore Record", "tags": [ "datastores" ] } }, "/api/v1/datastores/{datastore_id}/schema": { "put": { "description": "Write the schema records are validated against from now on: a new version when it differs\nfrom the latest, nothing at all when it does not. Records already stored are not revalidated.", "operationId": "put_datastore_schema_api_v1_datastores__datastore_id__schema_put", "parameters": [ { "in": "path", "name": "datastore_id", "required": true, "schema": { "title": "Datastore Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreSchemaWrite" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Put Datastore Schema", "tags": [ "datastores" ] } }, "/api/v1/datastores/{datastore_id}/schema/versions": { "get": { "description": "List a datastore's schema versions, oldest first; cursor = version number.", "operationId": "list_datastore_schema_versions_api_v1_datastores__datastore_id__schema_versions_get", "parameters": [ { "in": "path", "name": "datastore_id", "required": true, "schema": { "title": "Datastore Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_DatastoreSchemaVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Datastore Schema Versions", "tags": [ "datastores" ] } }, "/api/v1/datastores/{datastore_id}/schema/versions/{version}": { "get": { "description": "Fetch one schema version.", "operationId": "get_datastore_schema_version_api_v1_datastores__datastore_id__schema_versions__version__get", "parameters": [ { "in": "path", "name": "datastore_id", "required": true, "schema": { "title": "Datastore Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatastoreSchemaVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Datastore Schema Version", "tags": [ "datastores" ] } }, "/api/v1/decisions": { "post": { "description": "Choose one of `labels` for `input`, or answer `question` about it, with a catalogue model\nof kind `decision`.\n\nRefused before the model is called: `422` on `model` for anything but a decision model of\nthis organisation, `422` on the field that breaks the contract, `403` when the key's policy\nrefuses the model, `429` when the call's estimate would cross a monthly cap. Then `422` when\nthe model refuses the input and `503` when no decision could be made. The input tokens the\nmodel reported are billed as one `decision` row.", "operationId": "create_decision_api_v1_decisions_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecisionCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecisionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Decision", "tags": [ "decisions" ] } }, "/api/v1/evaluations": { "get": { "description": "List this tenant's evaluation suites, newest first.", "operationId": "list_evaluations_api_v1_evaluations_get", "parameters": [ { "description": "only rows concerning this agent", "in": "query", "name": "agent_id", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "only rows concerning this agent", "title": "Agent Id" } }, { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (desc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (desc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "name", "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_EvaluationRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Evaluations", "tags": [ "evaluations" ] }, "post": { "description": "Create an evaluation suite, link the agents it measures and nominate the key it runs as.", "operationId": "create_evaluation_api_v1_evaluations_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Evaluation", "tags": [ "evaluations" ] } }, "/api/v1/evaluations/{evaluation_id}": { "delete": { "description": "Delete a suite; its agent links, scenarios and runs go with it.", "operationId": "delete_evaluation_api_v1_evaluations__evaluation_id__delete", "parameters": [ { "in": "path", "name": "evaluation_id", "required": true, "schema": { "title": "Evaluation Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Evaluation", "tags": [ "evaluations" ] }, "get": { "description": "Fetch one suite with its agents, scenarios and latest runs.", "operationId": "get_evaluation_api_v1_evaluations__evaluation_id__get", "parameters": [ { "in": "path", "name": "evaluation_id", "required": true, "schema": { "title": "Evaluation Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Evaluation", "tags": [ "evaluations" ] }, "patch": { "description": "Change a suite; an absent field keeps what is stored, and `agents` replaces the whole set.", "operationId": "update_evaluation_api_v1_evaluations__evaluation_id__patch", "parameters": [ { "in": "path", "name": "evaluation_id", "required": true, "schema": { "title": "Evaluation Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Evaluation", "tags": [ "evaluations" ] } }, "/api/v1/evaluations/{evaluation_id}/comparison": { "get": { "description": "Two concluded runs of one suite side by side: per step both scores and both models, then\nwins, ties and losses, mean score, cost and latency. `409` while either has not concluded;\n`422` on the field naming a run this suite does not hold.", "operationId": "compare_runs_api_v1_evaluations__evaluation_id__comparison_get", "parameters": [ { "in": "path", "name": "evaluation_id", "required": true, "schema": { "title": "Evaluation Id", "type": "string" } }, { "description": "the run to hold against the other", "in": "query", "name": "run_id", "required": true, "schema": { "description": "the run to hold against the other", "maxLength": 64, "minLength": 1, "title": "Run Id", "type": "string" } }, { "description": "the run the first is held against", "in": "query", "name": "against_run_id", "required": true, "schema": { "description": "the run the first is held against", "maxLength": 64, "minLength": 1, "title": "Against Run Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunComparison" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Compare Runs", "tags": [ "evaluations" ] } }, "/api/v1/evaluations/{evaluation_id}/runs": { "get": { "description": "List a suite's runs, newest first, narrowed to one agent or to one schedule's fires.", "operationId": "list_runs_api_v1_evaluations__evaluation_id__runs_get", "parameters": [ { "in": "path", "name": "evaluation_id", "required": true, "schema": { "title": "Evaluation Id", "type": "string" } }, { "description": "only rows concerning this agent", "in": "query", "name": "agent_id", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "only rows concerning this agent", "title": "Agent Id" } }, { "description": "only the runs the fires of this schedule queued, which is how a standing instruction's own history is read", "in": "query", "name": "schedule_id", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "only the runs the fires of this schedule queued, which is how a standing instruction's own history is read", "title": "Schedule Id" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_RunSummary_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Runs", "tags": [ "evaluations" ] }, "post": { "description": "Queue one run per linked agent, or one for the agent named, each acting for the person\n`X-Core-Subject` names, if any. `202`: nothing has run yet.", "operationId": "queue_runs_api_v1_evaluations__evaluation_id__runs_post", "parameters": [ { "in": "path", "name": "evaluation_id", "required": true, "schema": { "title": "Evaluation Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueRunsRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RunSummary" }, "title": "Response Queue Runs Api V1 Evaluations Evaluation Id Runs Post", "type": "array" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Queue Runs", "tags": [ "evaluations" ] } }, "/api/v1/evaluations/{evaluation_id}/runs/{run_id}": { "get": { "description": "Fetch one run in full -- the snapshot it measured and every result so far.", "operationId": "get_run_api_v1_evaluations__evaluation_id__runs__run_id__get", "parameters": [ { "in": "path", "name": "evaluation_id", "required": true, "schema": { "title": "Evaluation Id", "type": "string" } }, { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Run", "tags": [ "evaluations" ] } }, "/api/v1/evaluations/{evaluation_id}/runs/{run_id}/cancel": { "post": { "description": "Ask a run to stop: a queued run stops now, a running one at its next step.", "operationId": "cancel_run_api_v1_evaluations__evaluation_id__runs__run_id__cancel_post", "parameters": [ { "in": "path", "name": "evaluation_id", "required": true, "schema": { "title": "Evaluation Id", "type": "string" } }, { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Cancel Run", "tags": [ "evaluations" ] } }, "/api/v1/evaluations/{evaluation_id}/scenarios": { "post": { "description": "Append a scenario at the next position.", "operationId": "create_scenario_api_v1_evaluations__evaluation_id__scenarios_post", "parameters": [ { "in": "path", "name": "evaluation_id", "required": true, "schema": { "title": "Evaluation Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScenarioWrite" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScenarioRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Scenario", "tags": [ "evaluations" ] } }, "/api/v1/evaluations/{evaluation_id}/scenarios/{scenario_id}": { "delete": { "description": "Delete one scenario; the positions around it are left as they are.", "operationId": "delete_scenario_api_v1_evaluations__evaluation_id__scenarios__scenario_id__delete", "parameters": [ { "in": "path", "name": "evaluation_id", "required": true, "schema": { "title": "Evaluation Id", "type": "string" } }, { "in": "path", "name": "scenario_id", "required": true, "schema": { "title": "Scenario Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Scenario", "tags": [ "evaluations" ] }, "put": { "description": "Replace a whole scenario at once -- title, description and every step.", "operationId": "write_scenario_api_v1_evaluations__evaluation_id__scenarios__scenario_id__put", "parameters": [ { "in": "path", "name": "evaluation_id", "required": true, "schema": { "title": "Evaluation Id", "type": "string" } }, { "in": "path", "name": "scenario_id", "required": true, "schema": { "title": "Scenario Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScenarioWrite" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScenarioRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Write Scenario", "tags": [ "evaluations" ] } }, "/api/v1/evaluations/{evaluation_id}/versions": { "get": { "description": "List the suite's published versions, oldest first; cursor = version number.", "operationId": "list_evaluation_versions_api_v1_evaluations__evaluation_id__versions_get", "parameters": [ { "in": "path", "name": "evaluation_id", "required": true, "schema": { "title": "Evaluation Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_EvaluationVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Evaluation Versions", "tags": [ "evaluations" ] }, "post": { "description": "Write the suite's next version whole and publish it: the judge, the agents and every\nscenario. A scenario sent with an `id` keeps it; one without is new.", "operationId": "create_evaluation_version_api_v1_evaluations__evaluation_id__versions_post", "parameters": [ { "in": "path", "name": "evaluation_id", "required": true, "schema": { "title": "Evaluation Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationVersionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Evaluation Version", "tags": [ "evaluations" ] } }, "/api/v1/evaluations/{evaluation_id}/versions/{version}": { "get": { "description": "Fetch one published version of the suite.", "operationId": "get_evaluation_version_api_v1_evaluations__evaluation_id__versions__version__get", "parameters": [ { "in": "path", "name": "evaluation_id", "required": true, "schema": { "title": "Evaluation Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Evaluation Version", "tags": [ "evaluations" ] } }, "/api/v1/events/stream": { "get": { "description": "Stream the organisation's events as server-sent events, from `Last-Event-ID` or `after`,\nor from now.\n\nEach frame is one `EventRead`: ids and a status, never a body. A comment line arrives when the\nfeed has been quiet, and Core ends the stream after `events_stream_max_seconds`, or sooner when\nthe credential stops being valid; reconnect with the last cursor you read and nothing is\nmissed. A `gap` frame first says the cursor is older than the events the feed still keeps. A\nsubject token's stream carries the events about its own person's rows, and -- where the\ndeployment sets `threads_group_reach_by_rule`, off by default -- those about a thread a rule\nnaming its person lets it see. `429` when the\norganisation already holds `events_max_streams_per_tenant` open streams, or -- for a subject\ntoken -- its person already holds `events_max_streams_per_subject`.", "operationId": "stream_events_api_v1_events_stream_get", "parameters": [ { "description": "resume after this cursor -- an event's `cursor`, or the `id` of the last frame read; `Last-Event-ID` says the same and wins when both are sent. Absent: start from now", "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "resume after this cursor -- an event's `cursor`, or the `id` of the last frame read; `Last-Event-ID` says the same and wins when both are sent. Absent: start from now", "title": "After" } }, { "description": "the cursor a reconnecting reader resumes after", "in": "header", "name": "Last-Event-ID", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "the cursor a reconnecting reader resumes after", "title": "Last-Event-Id" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "description": "Server-sent events: each frame's `id` is the event's cursor, its `event` the event's type and its `data` this object as JSON; a line starting with `:` is a heartbeat.", "properties": { "created_at": { "description": "When the event was produced", "format": "date-time", "title": "Created At", "type": "string" }, "cursor": { "description": "Where this event sits in the organisation's feed; opaque. A stream resumes after it from `Last-Event-ID` or `?after=`", "title": "Cursor", "type": "string" }, "id": { "description": "The event's id, the same on the stream and in a webhook", "title": "Id", "type": "string" }, "refs": { "additionalProperties": false, "description": "What one event is about: ids, a status, and -- for a connector sync -- counts.", "properties": { "added": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Sources a connector sync added", "title": "Added" }, "analysis_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The improvement analysis", "title": "Analysis Id" }, "cap_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Whose monthly cap crossed a threshold: 'organisation' or 'key'", "title": "Cap Kind" }, "check": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The check that found the proposal", "title": "Check" }, "collection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source's collection", "title": "Collection Id" }, "connector_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The connector that synced", "title": "Connector Id" }, "created": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the write made the record, rather than replaced it", "title": "Created" }, "datastore": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The datastore's name, which a trigger's filter can match", "title": "Datastore" }, "datastore_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The datastore a record event is about", "title": "Datastore Id" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The fixed code an ingestion or a workflow run failed with; never its message", "title": "Error Code" }, "failed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Items a connector sync failed on", "title": "Failed" }, "folder": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The watched folder the message is in", "title": "Folder" }, "index_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The knowledge index", "title": "Index Id" }, "item_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The item added", "title": "Item Id" }, "item_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The item's function: message, reasoning, tool_call, tool_result or refusal", "title": "Item Type" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The key of the record written or deleted", "title": "Key" }, "key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The key whose own cap crossed it", "title": "Key Id" }, "mail_connector": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The mail connector whose watched folder received a message", "title": "Mail Connector" }, "memory_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The memory record -- for an overdue commitment, the commitment", "title": "Memory Id" }, "period_start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The first instant of the cap period, UTC", "title": "Period Start" }, "proposal_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The improvement proposal", "title": "Proposal Id" }, "proposals": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Proposals a finished analysis wrote or refreshed", "title": "Proposals" }, "removed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Sources a connector sync removed", "title": "Removed" }, "response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The response or run", "title": "Response Id" }, "revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The revision the record was written at; on a delete, the last it had", "title": "Revision" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Whose authority wrote the item: user, model, developer, delegate or core", "title": "Role" }, "run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The reindex, connector sync or workflow run", "title": "Run Id" }, "skipped": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Items a connector sync skipped", "title": "Skipped" }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The knowledge source", "title": "Source Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The status the response, run, ingestion, reindex run or improvement analysis reached; 'overdue' for a commitment past its due time, 'open' for a new improvement proposal", "title": "Status" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Whose cap stopped a call: 'key:', 'tenant:' or 'ancestor'", "title": "Subject" }, "target_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The proposal's target", "title": "Target Id" }, "target_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "What the proposal is about: agent, prompt or skill", "title": "Target Kind" }, "task_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The task", "title": "Task Id" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The thread an item was added to, or a task belongs to", "title": "Thread Id" }, "threshold": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The percentage of the cap the month's spend reached", "title": "Threshold" }, "tool": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The qualified name of the tool a task runs", "title": "Tool" }, "uid": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The message's IMAP uid in that folder, which the connector's read tool reads", "title": "Uid" }, "updated": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Sources a connector sync updated", "title": "Updated" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The workflow a run is of", "title": "Workflow Id" } }, "title": "EventRefs", "type": "object" }, "type": { "description": "What happened", "enum": [ "thread.item.created", "response.completed", "response.failed", "response.incomplete", "response.cancelled", "response.check_failed", "run.suspended", "run.resumed", "run.approval.requested", "run.approval.decided", "thread.task.started", "thread.task.completed", "thread.task.failed", "thread.task.cancelled", "thread.task.expired", "knowledge.source.created", "knowledge.source.updated", "knowledge.source.deleted", "knowledge.source.restored", "knowledge.source.ingested", "knowledge.index.reindex_requested", "knowledge.index.reindexed", "knowledge.connector.synced", "memory.commitment_overdue", "mail.received", "improvements.proposal.created", "improvements.analysis.finished", "workflow.run.started", "workflow.run.completed", "workflow.run.failed", "workflow.run.cancelled", "workflow.run.expired", "workflow.decision.requested", "workflow.decision.decided", "workflow.decision.expired", "datastore.record.written", "datastore.record.deleted", "usage.threshold_reached", "usage.cap_exceeded" ], "title": "Type", "type": "string" } }, "required": [ "id", "type", "cursor", "created_at", "refs" ], "title": "EventStreamFrame", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Stream Events", "tags": [ "events" ] } }, "/api/v1/events/subscriptions": { "get": { "description": "List the organisation's webhook subscriptions, oldest first.", "operationId": "list_event_subscriptions_api_v1_events_subscriptions_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_EventSubscriptionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Event Subscriptions", "tags": [ "events" ] }, "post": { "description": "Register a webhook: every event of the chosen kinds (or of every kind) is POSTed to `url`,\nsigned with the `secret` this answer carries -- the one time Core shows it.\n\n`403` when the host is refused -- an address on a private network, a host the deployment\nblocks, one the organisation's allowed hosts or this key's own rules do not permit, or one\na regional key's `host_regions` does not place in its regions -- `409` when the\norganisation already holds `events_max_subscriptions`, `503` when this deployment cannot seal\na secret.", "operationId": "create_event_subscription_api_v1_events_subscriptions_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventSubscriptionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventSubscriptionSecret" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Event Subscription", "tags": [ "events" ] } }, "/api/v1/events/subscriptions/{subscription_id}": { "delete": { "description": "Delete a webhook subscription. A delivery already queued for it sends nothing. `403` for a\nkey other than the one that registered it, unless that key holds `management`.", "operationId": "delete_event_subscription_api_v1_events_subscriptions__subscription_id__delete", "parameters": [ { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Event Subscription", "tags": [ "events" ] }, "get": { "description": "Fetch one webhook subscription, without its secret.", "operationId": "get_event_subscription_api_v1_events_subscriptions__subscription_id__get", "parameters": [ { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventSubscriptionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Event Subscription", "tags": [ "events" ] } }, "/api/v1/events/subscriptions/{subscription_id}/rotate-secret": { "post": { "description": "Replace the subscription's signing secret and answer the new one, once. Deliveries signed\nfrom here on verify only against the new secret. `403` for a key other than the one that\nregistered it, unless that key holds `management`.", "operationId": "rotate_event_subscription_secret_api_v1_events_subscriptions__subscription_id__rotate_secret_post", "parameters": [ { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventSubscriptionSecret" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Rotate Event Subscription Secret", "tags": [ "events" ] } }, "/api/v1/exports": { "get": { "description": "List this key's own organisation's exports.", "operationId": "list_own_exports_api_v1_exports_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "in": "query", "name": "order", "required": false, "schema": { "default": "asc", "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "enum": [ "asc", "desc" ], "title": "Order", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ExportRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Exports", "tags": [ "exports" ] }, "post": { "description": "Queue an archive of this key's own organisation, or of one person in it.", "operationId": "create_own_export_api_v1_exports_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportCreate" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Own Export", "tags": [ "exports" ] } }, "/api/v1/exports/{export_id}": { "get": { "description": "One of this key's own organisation's exports.", "operationId": "get_own_export_api_v1_exports__export_id__get", "parameters": [ { "in": "path", "name": "export_id", "required": true, "schema": { "title": "Export Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Export", "tags": [ "exports" ] } }, "/api/v1/exports/{export_id}/download": { "get": { "description": "Stream the archive of one of this key's own organisation's exports.", "operationId": "download_own_export_api_v1_exports__export_id__download_get", "parameters": [ { "in": "path", "name": "export_id", "required": true, "schema": { "title": "Export Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "application/zip": { "schema": { "description": "The archive: a zip whose manifest.json names the format, every file with its row count, and what the archive does not contain.", "format": "binary", "title": "TenantExportArchive", "type": "string" } } }, "description": "Successful Response" }, "206": { "content": { "application/zip": { "schema": { "description": "The archive: a zip whose manifest.json names the format, every file with its row count, and what the archive does not contain.", "format": "binary", "title": "TenantExportArchive", "type": "string" } } }, "description": "Partial Content" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "416": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem416", "type": "object" } } }, "description": "Requested Range Not Satisfiable" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Download Own Export", "tags": [ "exports" ] } }, "/api/v1/files": { "get": { "description": "List the stored files this key reaches. With no filter: the uploads in the key's own\ncollection. `kind` adds other kinds, each left out unless the key holds its capability;\n`collection_id` names another collection the key reaches; `folder` narrows to one folder and,\nunless `recursive` is false, the folders beneath it; `trashed` lists the trash instead.", "operationId": "list_files_api_v1_files_get", "parameters": [ { "description": "only files of these kinds, repeatable; uploads alone when absent. A kind the caller holds no capability for is left out", "in": "query", "name": "kind", "required": false, "schema": { "anyOf": [ { "items": { "enum": [ "file", "artifact", "text", "records", "connector" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "only files of these kinds, repeatable; uploads alone when absent. A kind the caller holds no capability for is left out", "title": "Kind" } }, { "description": "only files in this collection; the key's own collection when absent", "in": "query", "name": "collection_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "only files in this collection; the key's own collection when absent", "title": "Collection Id" } }, { "description": "only rows in this folder and, unless `recursive` is false, beneath it, matched by whole path segments; an empty value names the root", "in": "query", "name": "folder", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "only rows in this folder and, unless `recursive` is false, beneath it, matched by whole path segments; an empty value names the root", "title": "Folder" } }, { "description": "whether rows in folders beneath `folder` count (the default); false returns the folder's own rows only", "in": "query", "name": "recursive", "required": false, "schema": { "default": true, "description": "whether rows in folders beneath `folder` count (the default); false returns the folder's own rows only", "title": "Recursive", "type": "boolean" } }, { "description": "list the rows in the trash instead of the live ones, each with when it was deleted and when it is purged; false (the default) lists the live rows", "in": "query", "name": "trashed", "required": false, "schema": { "default": false, "description": "list the rows in the trash instead of the live ones, each with when it was deleted and when it is purged; false (the default) lists the live rows", "title": "Trashed", "type": "boolean" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_FileRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Files", "tags": [ "files" ] }, "post": { "description": "Upload a file. It is stored as a source in this key's own knowledge collection unless\n`collection_id` names another one the key reaches, `folder` puts it in a folder (normalised\nby Core, `422` on a `.` or `..` segment), and it falls under the organisation's\nretention window unless `retention` says `keep`.\n\nAn upload into the key's own collection **waits for its own ingestion**, up to\n`files_ingest_wait_seconds`, so the next turn can search it; `index_status` says how far that\ngot (`docs/architecture/files-and-artifacts.md` \"Searchable uploads\").", "operationId": "create_file_api_v1_files_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_create_file_api_v1_files_post" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create File", "tags": [ "files" ] } }, "/api/v1/files/folders/move": { "post": { "description": "Rename or move a folder: every row this key reaches at `from` or beneath it moves to the\nsame place under `to`, all or nothing. A row the key may not change refuses the whole move\nas its own patch would, naming it; more than 500 rows is `422` on `from`.", "operationId": "move_file_folder_api_v1_files_folders_move_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderMoveCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderMoveRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Move File Folder", "tags": [ "files" ] } }, "/api/v1/files/{file_id}": { "delete": { "description": "Delete a stored file of any kind this key reaches into the trash: gone from every read\nat once, its bytes kept for `files_trash_days`. A file already in the trash is purged at\nonce, with its bytes. The audit event is named by the row's kind.", "operationId": "delete_file_api_v1_files__file_id__delete", "parameters": [ { "in": "path", "name": "file_id", "required": true, "schema": { "title": "File Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete File", "tags": [ "files" ] }, "get": { "description": "Fetch one stored file's metadata: an upload, or any other kind this key's capabilities\nreach -- an artifact with `artifacts`, a knowledge document with `knowledge`.", "operationId": "get_file_api_v1_files__file_id__get", "parameters": [ { "in": "path", "name": "file_id", "required": true, "schema": { "title": "File Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get File", "tags": [ "files" ] }, "patch": { "description": "Rename a stored file, move it and/or change its retention. An upload's new name must be\none this key's rules over `file` permit, or the rename is `403`; a synced document's folder\nis its connector's, so moving one is `409`.", "operationId": "update_file_api_v1_files__file_id__patch", "parameters": [ { "in": "path", "name": "file_id", "required": true, "schema": { "title": "File Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update File", "tags": [ "files" ] } }, "/api/v1/files/{file_id}/content": { "get": { "description": "Fetch a stored file's raw bytes as an attachment, whatever its kind. An artifact's are\ngated on the key's data-egress policy exactly as on `/artifacts/{id}/content`.", "operationId": "get_file_content_api_v1_files__file_id__content_get", "parameters": [ { "in": "path", "name": "file_id", "required": true, "schema": { "title": "File Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get File Content", "tags": [ "files" ] } }, "/api/v1/files/{file_id}/links": { "get": { "description": "List the share links on a stored file, oldest first. An expired link is listed with\n`expired: true` until it is revoked.", "operationId": "list_file_links_api_v1_files__file_id__links_get", "parameters": [ { "in": "path", "name": "file_id", "required": true, "schema": { "title": "File Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ShareLinkRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List File Links", "tags": [ "files" ] }, "post": { "description": "Share a stored HTML file through a link that opens it with no credential until it\nexpires. `403` unless the organisation's policy allows share links, `409` for a file that is\nnot HTML, `422` for a life longer than the policy allows.", "operationId": "create_file_link_api_v1_files__file_id__links_post", "parameters": [ { "in": "path", "name": "file_id", "required": true, "schema": { "title": "File Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ShareLinkCreate" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareLinkRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create File Link", "tags": [ "files" ] } }, "/api/v1/files/{file_id}/links/{link_id}": { "delete": { "description": "Revoke one share link on a stored file: its address stops opening the page at once.", "operationId": "revoke_file_link_api_v1_files__file_id__links__link_id__delete", "parameters": [ { "in": "path", "name": "file_id", "required": true, "schema": { "title": "File Id", "type": "string" } }, { "in": "path", "name": "link_id", "required": true, "schema": { "title": "Link Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Revoke File Link", "tags": [ "files" ] }, "get": { "description": "Fetch one share link on a stored file.", "operationId": "get_file_link_api_v1_files__file_id__links__link_id__get", "parameters": [ { "in": "path", "name": "file_id", "required": true, "schema": { "title": "File Id", "type": "string" } }, { "in": "path", "name": "link_id", "required": true, "schema": { "title": "Link Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareLinkRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get File Link", "tags": [ "files" ] } }, "/api/v1/files/{file_id}/restore": { "post": { "description": "Take a stored file of any kind this key reaches out of the trash, back on every read, and\ningest it anew. A `write`, refused as a rename is; `404` for a file not in the trash.", "operationId": "restore_file_api_v1_files__file_id__restore_post", "parameters": [ { "in": "path", "name": "file_id", "required": true, "schema": { "title": "File Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Restore File", "tags": [ "files" ] } }, "/api/v1/files/{file_id}/view": { "post": { "description": "Mint a short-lived address that serves a stored HTML file as a page. `409` for a file\nthat is not HTML or is a knowledge document; an artifact is gated on the key's data-egress\npolicy exactly as on `/artifacts/{id}/view`.", "operationId": "view_file_api_v1_files__file_id__view_post", "parameters": [ { "in": "path", "name": "file_id", "required": true, "schema": { "title": "File Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewTicketRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "View File", "tags": [ "files" ] } }, "/api/v1/functions": { "get": { "description": "List the organisation's functions by id, each with its latest version.", "operationId": "list_functions_api_v1_functions_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_FunctionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Functions", "tags": [ "functions" ] }, "post": { "description": "Register a function and its version 1. `409` when the name is taken; `422` on `module`\nfor a module that does not compile or imports anything outside the host interface.", "operationId": "create_function_api_v1_functions_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Function", "tags": [ "functions" ] } }, "/api/v1/functions/{function_id}": { "delete": { "description": "Delete a function and its versions. `409` naming the agents that name it.", "operationId": "delete_function_api_v1_functions__function_id__delete", "parameters": [ { "in": "path", "name": "function_id", "required": true, "schema": { "title": "Function Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Function", "tags": [ "functions" ] }, "get": { "description": "Fetch one function with its latest version.", "operationId": "get_function_api_v1_functions__function_id__get", "parameters": [ { "in": "path", "name": "function_id", "required": true, "schema": { "title": "Function Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Function", "tags": [ "functions" ] } }, "/api/v1/functions/{function_id}/versions": { "get": { "description": "List one function's versions, newest first; the cursor is a version number.", "operationId": "list_function_versions_api_v1_functions__function_id__versions_get", "parameters": [ { "in": "path", "name": "function_id", "required": true, "schema": { "title": "Function Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_FunctionVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Function Versions", "tags": [ "functions" ] }, "post": { "description": "Add the next version, holding the whole module. A body identical to the latest writes\nnone and answers the latest with `200`.", "operationId": "create_function_version_api_v1_functions__function_id__versions_post", "parameters": [ { "in": "path", "name": "function_id", "required": true, "schema": { "title": "Function Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionVersionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Function Version", "tags": [ "functions" ] } }, "/api/v1/functions/{function_id}/versions/{version}": { "get": { "description": "Fetch one version of a function.", "operationId": "get_function_version_api_v1_functions__function_id__versions__version__get", "parameters": [ { "in": "path", "name": "function_id", "required": true, "schema": { "title": "Function Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Function Version", "tags": [ "functions" ] } }, "/api/v1/improvements/analyses": { "get": { "description": "List this organisation's analyses, newest first.", "operationId": "list_improvement_analyses_api_v1_improvements_analyses_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AnalysisRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Improvement Analyses", "tags": [ "improvements" ] }, "post": { "description": "Queue an analysis of this organisation now; the worker runs it. `409` while the\norganisation's settings are off, or while another is queued or running.", "operationId": "run_improvement_analysis_api_v1_improvements_analyses_post", "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalysisRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Run Improvement Analysis", "tags": [ "improvements" ] } }, "/api/v1/improvements/analyses/{analysis_id}": { "get": { "description": "Read one analysis: the window it read, each check's outcome and counts, its model calls.", "operationId": "get_improvement_analysis_api_v1_improvements_analyses__analysis_id__get", "parameters": [ { "in": "path", "name": "analysis_id", "required": true, "schema": { "title": "Analysis Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalysisRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Improvement Analysis", "tags": [ "improvements" ] } }, "/api/v1/improvements/model": { "get": { "description": "Show which model this organisation's analyses call, and whether it is the organisation's\nown choice or the deployment's default; both null when there is none.", "operationId": "get_improvement_model_api_v1_improvements_model_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImprovementModelRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Improvement Model", "tags": [ "improvements" ] } }, "/api/v1/improvements/proposals": { "get": { "description": "List the proposals of this organisation's analyses, newest first, about what this key's\nrules reach: a key that does not reach an agent sees no proposal about it.", "operationId": "list_improvement_proposals_api_v1_improvements_proposals_get", "parameters": [ { "description": "Only proposals in this state", "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "enum": [ "open", "accepted", "dismissed", "applied", "resolved" ], "type": "string" }, { "type": "null" } ], "description": "Only proposals in this state", "title": "Status" } }, { "description": "Only proposals the named check wrote", "in": "query", "name": "check", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "Only proposals the named check wrote", "title": "Check" } }, { "description": "Only proposals about this kind of target", "in": "query", "name": "target_kind", "required": false, "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "description": "Only proposals about this kind of target", "title": "Target Kind" } }, { "description": "Only proposals about this target", "in": "query", "name": "target_id", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "Only proposals about this target", "title": "Target Id" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ProposalRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Improvement Proposals", "tags": [ "improvements" ] } }, "/api/v1/improvements/proposals/{proposal_id}": { "get": { "description": "Read one proposal with the ids of the turns it rests on; `404` for one about a target\nthis key's rules do not reach.", "operationId": "get_improvement_proposal_api_v1_improvements_proposals__proposal_id__get", "parameters": [ { "in": "path", "name": "proposal_id", "required": true, "schema": { "title": "Proposal Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProposalDetailRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Improvement Proposal", "tags": [ "improvements" ] }, "patch": { "description": "Accept, dismiss, reopen or mark applied a proposal, with a note; `409` for a move the\nproposal's state does not allow. Marking it applied is for a change made by hand.", "operationId": "update_improvement_proposal_api_v1_improvements_proposals__proposal_id__patch", "parameters": [ { "in": "path", "name": "proposal_id", "required": true, "schema": { "title": "Proposal Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProposalUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProposalDetailRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Improvement Proposal", "tags": [ "improvements" ] } }, "/api/v1/improvements/proposals/{proposal_id}/apply": { "post": { "description": "Apply a proposal: write its change, or the caller's own, as a new version or a new\nresource through that resource's own service, under every check its route makes for this\nkey; `Location` names what was written, unless that is a draft. `409` for a proposal Core\ncannot apply, one whose change still holds a placeholder, or one whose target has a newer\nversion than it was made against. A change that is embedded (a shared fact) is embedded\nfirst: `429` at the monthly cap, `503` without the embedding model.", "operationId": "apply_improvement_proposal_api_v1_improvements_proposals__proposal_id__apply_post", "parameters": [ { "in": "path", "name": "proposal_id", "required": true, "schema": { "title": "Proposal Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProposalApply" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProposalDetailRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Apply Improvement Proposal", "tags": [ "improvements" ] } }, "/api/v1/improvements/settings": { "get": { "description": "Read this organisation's improvement settings, every check included, and what last\nmonth's analyses did.", "operationId": "get_improvement_settings_api_v1_improvements_settings_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImprovementSettingsRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Improvement Settings", "tags": [ "improvements" ] }, "patch": { "description": "Change this organisation's improvement settings; turning analyses on is its consent to\nthem. Needs `management` beside `improvements`, under the `keys` reservation, because it\nspends the organisation's money as its helper model does. A field left out keeps its value.", "operationId": "update_improvement_settings_api_v1_improvements_settings_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImprovementSettingsUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImprovementSettingsRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Improvement Settings", "tags": [ "improvements" ] } }, "/api/v1/key": { "get": { "description": "Show the calling key's effective capabilities and policy: a caller can always ask\nwhich capabilities its key has.\n\n`residency` is the one part of the answer the organisation's document shapes too: the regions\nthe two documents meet at and the residency exceptions both make, so a strict key can see where\nits calls may go without the `management` read of its organisation's document\n(`docs/architecture/data-residency.md`).\n\nA request made with a subject token is refused `403`: that credential is this key narrowed to\none person and handed to that person's own device, and this answer carries the key's policy,\nits cost cap and the first characters of its secret -- everything the token exists to keep out\nof a browser.", "operationId": "get_own_key_api_v1_key_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyView" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Key", "tags": [ "key" ] } }, "/api/v1/key/callback-secret": { "post": { "description": "Create the calling key's callback secret, or replace the one it has, and answer it once.\n\nEvery run callback of this key is signed with it from here on, as an event webhook is; a key\nthat never asks keeps sending callbacks unsigned. Needs no `management`: the secret is what\nthis key's own receiver trusts. `503` when the deployment holds no key to seal it with, and\n`403` for a subject token, as on `GET /key`.", "operationId": "create_own_callback_secret_api_v1_key_callback_secret_post", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyCallbackSecret" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Own Callback Secret", "tags": [ "key" ] } }, "/api/v1/keys": { "get": { "description": "List the API keys of the organisation this key belongs to, the calling one included.\n\nReading which credentials exist is never withheld: an organisation whose parent reserved key\nmanagement to itself can still answer for the keys it has.", "operationId": "list_own_organisation_keys_api_v1_keys_get", "parameters": [ { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_KeyRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Organisation Keys", "tags": [ "organisation" ] }, "post": { "description": "Issue an API key for the organisation this key belongs to. The secret is in this response\nand nowhere else.\n\nWhat may be switched on is this organisation's own ceiling, `management` included: a key\nholding `management` grants exactly what an administrator of the same organisation grants,\nwhich is why few keys should hold it.", "operationId": "register_own_organisation_key_api_v1_keys_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyIssued" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Register Own Organisation Key", "tags": [ "organisation" ] } }, "/api/v1/keys/{key_id}": { "delete": { "description": "Deregister one key of this organisation. The organisation and everything it owns are\nuntouched.", "operationId": "delete_own_organisation_key_api_v1_keys__key_id__delete", "parameters": [ { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Own Organisation Key", "tags": [ "organisation" ] }, "get": { "description": "Show one key of the organisation this key belongs to.", "operationId": "get_own_organisation_key_api_v1_keys__key_id__get", "parameters": [ { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Organisation Key", "tags": [ "organisation" ] }, "patch": { "description": "Update one key's name, capabilities, policy or monthly cap -- including the calling key's\nown, which is how a key narrows itself, except its own cap: that is `403`, as an\norganisation's own cap is. `If-Match` holds the update to the `policy_version` a read\nanswered.", "operationId": "update_own_organisation_key_api_v1_keys__key_id__patch", "parameters": [ { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } }, { "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "in": "header", "name": "If-Match", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "title": "If-Match" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Own Organisation Key", "tags": [ "organisation" ] } }, "/api/v1/keys/{key_id}/callback-secret": { "post": { "description": "Create the callback secret of one key of this organisation, or replace the one it has,\nand answer it once. A key does this for itself, without `management`, through\n`POST /key/callback-secret`.", "operationId": "create_own_organisation_key_callback_secret_api_v1_keys__key_id__callback_secret_post", "parameters": [ { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyCallbackSecret" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Own Organisation Key Callback Secret", "tags": [ "organisation" ] } }, "/api/v1/keys/{key_id}/disable": { "post": { "description": "Disable one key of this organisation until it is enabled again -- the calling key's own\nincluded, which ends the request after this one.", "operationId": "disable_own_organisation_key_api_v1_keys__key_id__disable_post", "parameters": [ { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Disable Own Organisation Key", "tags": [ "organisation" ] } }, "/api/v1/keys/{key_id}/enable": { "post": { "description": "Enable one disabled key of this organisation again.", "operationId": "enable_own_organisation_key_api_v1_keys__key_id__enable_post", "parameters": [ { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Enable Own Organisation Key", "tags": [ "organisation" ] } }, "/api/v1/keys/{key_id}/rotate": { "post": { "description": "Replace a key's secret, returning the new one. The previous secret stops working -- the\ncalling key's own included, which ends the request after this one.", "operationId": "rotate_own_organisation_key_api_v1_keys__key_id__rotate_post", "parameters": [ { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyRotate" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyIssued" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Rotate Own Organisation Key", "tags": [ "organisation" ] } }, "/api/v1/knowledge/chunks/{chunk_id}": { "get": { "description": "Read the chunk a search hit or a `file_citation` names: its text, bounded, and the index\nand source it came from -- only where the search that found it could be run, and `404`\nwherever it could not, never `403`.", "operationId": "get_chunk_api_v1_knowledge_chunks__chunk_id__get", "parameters": [ { "in": "path", "name": "chunk_id", "required": true, "schema": { "title": "Chunk Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexChunkRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Chunk", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/collections": { "get": { "description": "List the tenant's knowledge collections.", "operationId": "list_collections_api_v1_knowledge_collections_get", "parameters": [ { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "name", "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_CollectionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Collections", "tags": [ "knowledge" ] }, "post": { "description": "Create a knowledge collection.", "operationId": "create_collection_api_v1_knowledge_collections_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Collection", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/collections/{collection_id}": { "delete": { "description": "Erase a collection; its sources, chunks and rows cascade at the database.", "operationId": "delete_collection_api_v1_knowledge_collections__collection_id__delete", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Collection", "tags": [ "knowledge" ] }, "get": { "description": "Fetch one knowledge collection.", "operationId": "get_collection_api_v1_knowledge_collections__collection_id__get", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Collection", "tags": [ "knowledge" ] }, "patch": { "description": "Update a collection's name, description and/or metadata.", "operationId": "update_collection_api_v1_knowledge_collections__collection_id__patch", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Collection", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/collections/{collection_id}/connector": { "delete": { "description": "Erase this collection's connector; the sources it created stay where they are.", "operationId": "delete_connector_api_v1_knowledge_collections__collection_id__connector_delete", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Connector", "tags": [ "knowledge" ] }, "get": { "description": "Fetch this collection's connector. No credential is ever part of the answer.", "operationId": "get_connector_api_v1_knowledge_collections__collection_id__connector_get", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Connector", "tags": [ "knowledge" ] }, "patch": { "description": "Change this connector's settings and/or schedule; a secret field present rotates it.", "operationId": "patch_connector_api_v1_knowledge_collections__collection_id__connector_patch", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Patch Connector", "tags": [ "knowledge" ] }, "put": { "description": "Create or replace this collection's connector. 503 when the deployment configures no\nkey to seal a connector's credentials with.", "operationId": "put_connector_api_v1_knowledge_collections__collection_id__connector_put", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorPut" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Put Connector", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/collections/{collection_id}/connector/runs": { "get": { "description": "List this connector's sync runs.", "operationId": "list_sync_runs_api_v1_knowledge_collections__collection_id__connector_runs_get", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_SyncRunRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Sync Runs", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/collections/{collection_id}/connector/runs/{run_id}": { "get": { "description": "Fetch one sync run.", "operationId": "get_sync_run_api_v1_knowledge_collections__collection_id__connector_runs__run_id__get", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } }, { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncRunRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Sync Run", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/collections/{collection_id}/connector/sync": { "post": { "description": "Queue a sync of this connector; 409 while one is already queued or running.", "operationId": "start_sync_api_v1_knowledge_collections__collection_id__connector_sync_post", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncRunRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Start Sync", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/collections/{collection_id}/connector/sync/cancel": { "post": { "description": "Ask the active sync to stop; it stops between items. 409 when none is active.", "operationId": "cancel_sync_api_v1_knowledge_collections__collection_id__connector_sync_cancel_post", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncRunRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Cancel Sync", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/collections/{collection_id}/connector/test": { "post": { "description": "Reach this connector's system and list at most one item; store nothing. A failure is a\n200 carrying `ok: false` and a fixed code -- the request itself succeeded, the connector is\nwhat did not.", "operationId": "test_connector_api_v1_knowledge_collections__collection_id__connector_test_post", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorTestRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Test Connector", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/collections/{collection_id}/sources": { "get": { "description": "List a collection's sources this request's subject reaches, optionally narrowed by\n`folder` (whole path segments of the `folder` metadata, with the folders beneath it unless\n`recursive` is false), `q` (title contains, case-insensitive)\nand repeatable `status` (an ingestion status any of the source's index pairs carries).", "operationId": "list_sources_api_v1_knowledge_collections__collection_id__sources_get", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } }, { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "only sources with a pair at any of these ingestion statuses, repeatable", "in": "query", "name": "status", "required": false, "schema": { "description": "only sources with a pair at any of these ingestion statuses, repeatable", "items": { "enum": [ "queued", "processing", "ready", "failed" ], "type": "string" }, "title": "Status", "type": "array" } }, { "description": "only rows in this folder and, unless `recursive` is false, beneath it, matched by whole path segments; an empty value names the root", "in": "query", "name": "folder", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "description": "only rows in this folder and, unless `recursive` is false, beneath it, matched by whole path segments; an empty value names the root", "title": "Folder" } }, { "description": "whether rows in folders beneath `folder` count (the default); false returns the folder's own rows only", "in": "query", "name": "recursive", "required": false, "schema": { "default": true, "description": "whether rows in folders beneath `folder` count (the default); false returns the folder's own rows only", "title": "Recursive", "type": "boolean" } }, { "description": "only sources whose title contains this, case-insensitive", "in": "query", "name": "q", "required": false, "schema": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "description": "only sources whose title contains this, case-insensitive", "title": "Q" } }, { "description": "list the rows in the trash instead of the live ones, each with when it was deleted and when it is purged; false (the default) lists the live rows", "in": "query", "name": "trashed", "required": false, "schema": { "default": false, "description": "list the rows in the trash instead of the live ones, each with when it was deleted and when it is purged; false (the default) lists the live rows", "title": "Trashed", "type": "boolean" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_SourceRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Sources", "tags": [ "knowledge" ] }, "post": { "description": "Create a source in this collection; ingestion is enqueued for every index that draws it\nin -- one selecting the collection whose link filter this source's metadata satisfies. A\nsource created for a person carries that person, and is theirs to read from then on.", "operationId": "create_source_api_v1_knowledge_collections__collection_id__sources_post", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "discriminator": { "mapping": { "file": "#/components/schemas/FileSourceCreate", "records": "#/components/schemas/RecordsSourceCreate", "text": "#/components/schemas/TextSourceCreate" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/TextSourceCreate" }, { "$ref": "#/components/schemas/FileSourceCreate" }, { "$ref": "#/components/schemas/RecordsSourceCreate" } ], "title": "Body" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Source", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/collections/{collection_id}/sources/upload": { "post": { "description": "Create a source from a file in one call: the bytes go straight into this collection, with\nno `/files` upload to delete afterwards.\n\nIts own path rather than a second body shape on `POST .../sources`: one operation cannot\ndeclare both a JSON body and multipart fields, and the generated clients and the gateway are\nbuilt from this schema (`docs/architecture/api-conventions.md`). `metadata` is a JSON object\nof string values, as a string -- multipart carries no types of its own.", "operationId": "upload_source_api_v1_knowledge_collections__collection_id__sources_upload_post", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_source_api_v1_knowledge_collections__collection_id__sources_upload_post" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Upload Source", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/collections/{collection_id}/sources/{source_id}": { "delete": { "description": "Delete a source into the trash: gone from every read and search at once, its chunks and\nper-index ingestion state removed, and its bytes kept until it is purged. A source already in\nthe trash is purged at once, with its bytes.", "operationId": "delete_source_api_v1_knowledge_collections__collection_id__sources__source_id__delete", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } }, { "in": "path", "name": "source_id", "required": true, "schema": { "title": "Source Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Source", "tags": [ "knowledge" ] }, "get": { "description": "Fetch one source; one another person owns is the same `404` one of another tenant is.", "operationId": "get_source_api_v1_knowledge_collections__collection_id__sources__source_id__get", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } }, { "in": "path", "name": "source_id", "required": true, "schema": { "title": "Source Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Source", "tags": [ "knowledge" ] }, "patch": { "description": "Update a source's title and/or metadata. Replacing the metadata re-routes the source:\nan index whose filter it now satisfies ingests it, one it no longer satisfies drops its\nchunks, and one that still does has its chunks' metadata rewritten in place. A synced\ndocument's folder is its connector's, so changing it is `409`.", "operationId": "update_source_api_v1_knowledge_collections__collection_id__sources__source_id__patch", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } }, { "in": "path", "name": "source_id", "required": true, "schema": { "title": "Source Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Source", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/collections/{collection_id}/sources/{source_id}/content": { "get": { "description": "Fetch a source's original bytes as an attachment named after its title. An artifact's are\ngated on the key's data-egress policy exactly as on `/artifacts/{id}/content`.", "operationId": "get_source_content_api_v1_knowledge_collections__collection_id__sources__source_id__content_get", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } }, { "in": "path", "name": "source_id", "required": true, "schema": { "title": "Source Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Source Content", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/collections/{collection_id}/sources/{source_id}/query": { "post": { "description": "Query one of a source's tables: filters, an optional aggregate and group_by, over the\ntable `table_id` names -- or the source's only one when the body names none. 404 when\n`source_id` does not belong to `collection_id`, or when `table_id` is not one of its tables.", "operationId": "query_source_api_v1_knowledge_collections__collection_id__sources__source_id__query_post", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } }, { "in": "path", "name": "source_id", "required": true, "schema": { "title": "Source Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceQueryRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_dict_str__Any__" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Query Source", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/collections/{collection_id}/sources/{source_id}/restore": { "post": { "description": "Take a source out of the trash, back on every read, and ingest it anew. A `write`,\nrefused as a rename is; `404` for a source not in the trash.", "operationId": "restore_source_api_v1_knowledge_collections__collection_id__sources__source_id__restore_post", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } }, { "in": "path", "name": "source_id", "required": true, "schema": { "title": "Source Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Restore Source", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/collections/{collection_id}/sources/{source_id}/tables": { "get": { "description": "A source's extracted tables, in the order they were found: one per worksheet, body or\nMarkdown pipe table, each with its own schema and row count. Not paged: a source's tables are\nbounded by the extracting node's own `max_tables`.", "operationId": "list_source_tables_api_v1_knowledge_collections__collection_id__sources__source_id__tables_get", "parameters": [ { "in": "path", "name": "collection_id", "required": true, "schema": { "title": "Collection Id", "type": "string" } }, { "in": "path", "name": "source_id", "required": true, "schema": { "title": "Source Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_TableRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Source Tables", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/graphs": { "get": { "description": "List the knowledge graphs this key reaches.", "operationId": "list_graphs_api_v1_knowledge_graphs_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_GraphRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Graphs", "tags": [ "knowledge" ] }, "post": { "description": "Create a knowledge graph, with its first schema version when the body carries one, and\nthe collections and ingest pipeline that fill it.", "operationId": "create_graph_api_v1_knowledge_graphs_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Graph", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/graphs/{graph_id}": { "delete": { "description": "Delete a graph with its schema versions and every fact in it.", "operationId": "delete_graph_api_v1_knowledge_graphs__graph_id__delete", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Graph", "tags": [ "knowledge" ] }, "get": { "description": "Fetch one knowledge graph.", "operationId": "get_graph_api_v1_knowledge_graphs__graph_id__get", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Graph", "tags": [ "knowledge" ] }, "patch": { "description": "Change a graph's description, labels, collections, ingest pipeline or embedding model;\nits name and visibility never change. Another pipeline or model answers\n`reindex_required: true`.", "operationId": "update_graph_api_v1_knowledge_graphs__graph_id__patch", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Graph", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/graphs/{graph_id}/entities": { "get": { "description": "List the entities the named person sees, oldest first.", "operationId": "list_entities_api_v1_knowledge_graphs__graph_id__entities_get", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } }, { "description": "only facts of this type", "in": "query", "name": "type", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "only facts of this type", "title": "Type" } }, { "description": "only entities whose name or an alias matches, as a query's start name does", "in": "query", "name": "q", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "only entities whose name or an alias matches, as a query's start name does", "title": "Q" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_EntityRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Entities", "tags": [ "knowledge" ] }, "post": { "description": "Write a manual entity; `409` while the graph has no schema.", "operationId": "create_entity_api_v1_knowledge_graphs__graph_id__entities_post", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Entity", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/graphs/{graph_id}/entities/{entity_id}": { "delete": { "description": "Delete a manual entity and its relations; an extracted one is `409`.", "operationId": "delete_entity_api_v1_knowledge_graphs__graph_id__entities__entity_id__delete", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } }, { "in": "path", "name": "entity_id", "required": true, "schema": { "title": "Entity Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Entity", "tags": [ "knowledge" ] }, "get": { "description": "Fetch one entity as the named person sees it.", "operationId": "get_entity_api_v1_knowledge_graphs__graph_id__entities__entity_id__get", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } }, { "in": "path", "name": "entity_id", "required": true, "schema": { "title": "Entity Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Entity", "tags": [ "knowledge" ] }, "patch": { "description": "Change a manual entity; an extracted one is `409`.", "operationId": "update_entity_api_v1_knowledge_graphs__graph_id__entities__entity_id__patch", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } }, { "in": "path", "name": "entity_id", "required": true, "schema": { "title": "Entity Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Entity", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/graphs/{graph_id}/query": { "post": { "description": "Run a `GraphQuery`, validated against the graph's latest schema version, as the named\nperson reads the graph.", "operationId": "query_graph_api_v1_knowledge_graphs__graph_id__query_post", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphQuery" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphQueryResult" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Query Graph", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/graphs/{graph_id}/reindex": { "post": { "description": "Queue a reindex of the graph: `full` (the default) re-extracts every source it draws in\nand takes out what the sources it no longer draws in said; `failed` retries the pairs whose\nlast ingestion failed.", "operationId": "create_graph_reindex_run_api_v1_knowledge_graphs__graph_id__reindex_post", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ReindexRequest" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphRunRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Graph Reindex Run", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/graphs/{graph_id}/relations": { "get": { "description": "List the relations the named person sees, oldest first.", "operationId": "list_relations_api_v1_knowledge_graphs__graph_id__relations_get", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } }, { "description": "only facts of this type", "in": "query", "name": "type", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "only facts of this type", "title": "Type" } }, { "description": "only relations with this entity at either end", "in": "query", "name": "entity_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "only relations with this entity at either end", "title": "Entity Id" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_RelationRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Relations", "tags": [ "knowledge" ] }, "post": { "description": "Write a manual relation between two entities of the graph.", "operationId": "create_relation_api_v1_knowledge_graphs__graph_id__relations_post", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelationCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Relation", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/graphs/{graph_id}/relations/{relation_id}": { "delete": { "description": "Delete a manual relation; an extracted one is `409`.", "operationId": "delete_relation_api_v1_knowledge_graphs__graph_id__relations__relation_id__delete", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } }, { "in": "path", "name": "relation_id", "required": true, "schema": { "title": "Relation Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Relation", "tags": [ "knowledge" ] }, "get": { "description": "Fetch one relation as the named person sees it.", "operationId": "get_relation_api_v1_knowledge_graphs__graph_id__relations__relation_id__get", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } }, { "in": "path", "name": "relation_id", "required": true, "schema": { "title": "Relation Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Relation", "tags": [ "knowledge" ] }, "patch": { "description": "Replace a manual relation's properties; an extracted one is `409`.", "operationId": "update_relation_api_v1_knowledge_graphs__graph_id__relations__relation_id__patch", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } }, { "in": "path", "name": "relation_id", "required": true, "schema": { "title": "Relation Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelationUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Relation", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/graphs/{graph_id}/runs": { "get": { "description": "List the graph's reindex runs.", "operationId": "list_graph_runs_api_v1_knowledge_graphs__graph_id__runs_get", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_GraphRunRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Graph Runs", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/graphs/{graph_id}/runs/{run_id}": { "get": { "description": "Fetch one reindex run of the graph.", "operationId": "get_graph_run_api_v1_knowledge_graphs__graph_id__runs__run_id__get", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } }, { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphRunRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Graph Run", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/graphs/{graph_id}/schema": { "get": { "description": "Fetch the graph's latest schema version; `404` while it has none.", "operationId": "get_graph_schema_api_v1_knowledge_graphs__graph_id__schema_get", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphSchemaVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Graph Schema", "tags": [ "knowledge" ] }, "put": { "description": "Write the schema facts are validated against from now on: a new version when it differs\nfrom the latest, answered with `reindex_required: true`; nothing when it does not.", "operationId": "put_graph_schema_api_v1_knowledge_graphs__graph_id__schema_put", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphSchemaWrite" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Put Graph Schema", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/graphs/{graph_id}/schema/versions": { "get": { "description": "List a graph's schema versions, oldest first; cursor = version number.", "operationId": "list_graph_schema_versions_api_v1_knowledge_graphs__graph_id__schema_versions_get", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_GraphSchemaVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Graph Schema Versions", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/graphs/{graph_id}/schema/versions/{version}": { "get": { "description": "Fetch one schema version.", "operationId": "get_graph_schema_version_api_v1_knowledge_graphs__graph_id__schema_versions__version__get", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphSchemaVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Graph Schema Version", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/graphs/{graph_id}/sources": { "get": { "description": "List the graph's per-source ingestion state, narrowed to the sources the named person may\nread: every row carries its source's title.", "operationId": "list_graph_sources_api_v1_knowledge_graphs__graph_id__sources_get", "parameters": [ { "in": "path", "name": "graph_id", "required": true, "schema": { "title": "Graph Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_SourceGraphStateRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Graph Sources", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/indexes": { "get": { "description": "List the tenant's knowledge indexes.", "operationId": "list_indexes_api_v1_knowledge_indexes_get", "parameters": [ { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "name", "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_IndexRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Indexes", "tags": [ "knowledge" ] }, "post": { "description": "Create a knowledge index.", "operationId": "create_index_api_v1_knowledge_indexes_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Index", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/indexes/{index_id}": { "delete": { "description": "Erase an index; its collection links and chunks cascade at the database. The sources of\nthe collections it selected are untouched -- they belong to their collection, not this index.\nAn API key's own index answers `409`: turn off that key's `files.index_uploads` instead. So\ndoes an index a key injects memory from, or whose memory extraction is on, naming the user.", "operationId": "delete_index_api_v1_knowledge_indexes__index_id__delete", "parameters": [ { "in": "path", "name": "index_id", "required": true, "schema": { "title": "Index Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Index", "tags": [ "knowledge" ] }, "get": { "description": "Fetch one knowledge index.", "operationId": "get_index_api_v1_knowledge_indexes__index_id__get", "parameters": [ { "in": "path", "name": "index_id", "required": true, "schema": { "title": "Index Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Index", "tags": [ "knowledge" ] }, "patch": { "description": "Update an index. Changing `embedding_model`, `ingest_pipeline` or what `collection_ids`\nselect bumps `epoch` and answers with `reindex_required: true`. An API key's own index\nanswers `409` to a rename, and to new `labels` or `collection_ids` unless they put it back to\nthat key's own collection alone with no labels.", "operationId": "update_index_api_v1_knowledge_indexes__index_id__patch", "parameters": [ { "in": "path", "name": "index_id", "required": true, "schema": { "title": "Index Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Index", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/indexes/{index_id}/chunks/{chunk_id}/image": { "get": { "description": "Fetch the picture an image hit links to: the bytes of one picture of the chunk's source,\nexactly as the source holds them, read only where the search that found it could be run.", "operationId": "get_chunk_image_api_v1_knowledge_indexes__index_id__chunks__chunk_id__image_get", "parameters": [ { "in": "path", "name": "index_id", "required": true, "schema": { "title": "Index Id", "type": "string" } }, { "in": "path", "name": "chunk_id", "required": true, "schema": { "title": "Chunk Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "image/*": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Chunk Image", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/indexes/{index_id}/reindex": { "post": { "description": "Queue a reindex of this index. `full` (the default, and what a request with no body at\nall means) covers every source the index currently draws in; `failed` re-queues only the\npairs whose last ingestion failed.", "operationId": "create_reindex_run_api_v1_knowledge_indexes__index_id__reindex_post", "parameters": [ { "in": "path", "name": "index_id", "required": true, "schema": { "title": "Index Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ReindexRequest" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexRunRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Reindex Run", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/indexes/{index_id}/runs": { "get": { "description": "List this index's reindex runs.", "operationId": "list_runs_api_v1_knowledge_indexes__index_id__runs_get", "parameters": [ { "in": "path", "name": "index_id", "required": true, "schema": { "title": "Index Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_IndexRunRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Runs", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/indexes/{index_id}/runs/{run_id}": { "get": { "description": "Fetch one reindex run.", "operationId": "get_run_api_v1_knowledge_indexes__index_id__runs__run_id__get", "parameters": [ { "in": "path", "name": "index_id", "required": true, "schema": { "title": "Index Id", "type": "string" } }, { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexRunRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Run", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/indexes/{index_id}/search": { "post": { "description": "Search one index's chunks through Core's built-in retrieval pipeline, narrowed to the\nsources the named person may read.", "operationId": "search_index_api_v1_knowledge_indexes__index_id__search_post", "parameters": [ { "in": "path", "name": "index_id", "required": true, "schema": { "title": "Index Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_Hit_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Search Index", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/indexes/{index_id}/sources": { "get": { "description": "List this index's per-source ingestion state (one row per source it has queued, is\nprocessing, has finished, or has failed to ingest), narrowed to the sources the named person\nmay read -- every row carries its source's title, so this is a read of a source like any\nother. `X-Core-Subject`, as the eight source routes take it: this route has no body.", "operationId": "list_index_sources_api_v1_knowledge_indexes__index_id__sources_get", "parameters": [ { "in": "path", "name": "index_id", "required": true, "schema": { "title": "Index Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_SourceIndexStateRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Index Sources", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/indexes/{index_id}/stats": { "get": { "description": "What this index holds: sources by ingestion status, stored chunks, structured rows, the\nembedding model and width in force, its last refresh and any reindex run under way.", "operationId": "get_index_stats_api_v1_knowledge_indexes__index_id__stats_get", "parameters": [ { "in": "path", "name": "index_id", "required": true, "schema": { "title": "Index Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexStatsRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Index Stats", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/pipeline-components": { "get": { "description": "The component registry, partitioned into `{\"ingest\": {...}, \"retrieval\": {...}}`; each\nentry's `available` reflects whether this deployment configures what it `requires`, and its\n`inputs`/`outputs` name every port an edge may reach or leave.", "operationId": "pipeline_components_api_v1_knowledge_pipeline_components_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineComponentsRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Pipeline Components", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/pipeline-templates": { "get": { "description": "The built-in pipeline templates a tenant can clone with\n`POST /knowledge/pipelines/from-template`. Not actually paginated -- the built-in list is\nshort and fixed -- but shaped like every other list (`next_cursor` always `null`) so a\ngeneric list client needs no special case.", "operationId": "pipeline_templates_api_v1_knowledge_pipeline_templates_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_PipelineTemplateRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Pipeline Templates", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/pipelines": { "get": { "description": "List the tenant's pipelines, each with its latest version.", "operationId": "list_pipelines_api_v1_knowledge_pipelines_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_PipelineRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Pipelines", "tags": [ "knowledge" ] }, "post": { "description": "Create a pipeline and its first version.", "operationId": "create_pipeline_api_v1_knowledge_pipelines_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Pipeline", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/pipelines/from-template": { "post": { "description": "Clone a built-in template into a new, tenant-owned pipeline.", "operationId": "create_from_template_api_v1_knowledge_pipelines_from_template_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineFromTemplateCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create From Template", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/pipelines/{pipeline_id}": { "delete": { "description": "Delete a pipeline and all its versions.", "operationId": "delete_pipeline_api_v1_knowledge_pipelines__pipeline_id__delete", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "title": "Pipeline Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Pipeline", "tags": [ "knowledge" ] }, "get": { "description": "Fetch one pipeline with its latest version.", "operationId": "get_pipeline_api_v1_knowledge_pipelines__pipeline_id__get", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "title": "Pipeline Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Pipeline", "tags": [ "knowledge" ] }, "patch": { "description": "Update a pipeline's name and/or description. The DAG itself is never patched here -- add\na new version instead.", "operationId": "update_pipeline_api_v1_knowledge_pipelines__pipeline_id__patch", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "title": "Pipeline Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Pipeline", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/pipelines/{pipeline_id}/models": { "get": { "description": "List the chat model every step of the pipeline's latest version calls, where each runs,\nand whether the calling key's policy admits it -- so a key can see which step a strict\npolicy would stop before any run does (`app.knowledge.pipeline_hosting`).\n\nPlaced through the catalogue narrowed to this organisation, as a run's own decision places a\nstep's model (`app.knowledge.pipelines.executor.decide_node_model`), and decided by the same\n`decide_model` with the person's `model` rules when the request names one. The turn's own\n`hosting.region` is not weighed: it narrows one turn rather than this list. Paged in memory\nby step, in the graph's own order; a pipeline holds at most a few dozen steps.", "operationId": "list_pipeline_models_api_v1_knowledge_pipelines__pipeline_id__models_get", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "title": "Pipeline Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_PipelineModelRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Pipeline Models", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/pipelines/{pipeline_id}/test": { "post": { "description": "Run one of the tenant's pipelines over a supplied input and show what it produced. A\nretrieval pipeline takes `query` (and the `index_ids` to search), an ingest pipeline takes\n`text`; nothing is stored either way, though model and embedding calls are still metered.", "operationId": "test_pipeline_api_v1_knowledge_pipelines__pipeline_id__test_post", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "title": "Pipeline Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineTestRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineTestRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Test Pipeline", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/pipelines/{pipeline_id}/versions": { "get": { "description": "List a pipeline's versions, oldest first; cursor = version number.", "operationId": "list_versions_api_v1_knowledge_pipelines__pipeline_id__versions_get", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "title": "Pipeline Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_PipelineVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Versions", "tags": [ "knowledge" ] }, "post": { "description": "Add a new version to a pipeline.", "operationId": "create_version_api_v1_knowledge_pipelines__pipeline_id__versions_post", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "title": "Pipeline Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineVersionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Version", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/pipelines/{pipeline_id}/versions/{version}": { "get": { "description": "Fetch one specific version of a pipeline.", "operationId": "get_version_api_v1_knowledge_pipelines__pipeline_id__versions__version__get", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "title": "Pipeline Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Version", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/retrieval-tools": { "get": { "description": "List the tenant's retrieval tools.", "operationId": "list_retrieval_tools_api_v1_knowledge_retrieval_tools_get", "parameters": [ { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "name", "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_RetrievalToolRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Retrieval Tools", "tags": [ "knowledge" ] }, "post": { "description": "Create a retrieval tool.", "operationId": "create_retrieval_tool_api_v1_knowledge_retrieval_tools_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalToolCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalToolRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Retrieval Tool", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/retrieval-tools/{tool_id}": { "delete": { "description": "Delete a retrieval tool.", "operationId": "delete_retrieval_tool_api_v1_knowledge_retrieval_tools__tool_id__delete", "parameters": [ { "in": "path", "name": "tool_id", "required": true, "schema": { "title": "Tool Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Retrieval Tool", "tags": [ "knowledge" ] }, "get": { "description": "Fetch one retrieval tool.", "operationId": "get_retrieval_tool_api_v1_knowledge_retrieval_tools__tool_id__get", "parameters": [ { "in": "path", "name": "tool_id", "required": true, "schema": { "title": "Tool Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalToolRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Retrieval Tool", "tags": [ "knowledge" ] }, "patch": { "description": "Update a retrieval tool.", "operationId": "update_retrieval_tool_api_v1_knowledge_retrieval_tools__tool_id__patch", "parameters": [ { "in": "path", "name": "tool_id", "required": true, "schema": { "title": "Tool Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalToolUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalToolRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Retrieval Tool", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/retrieval-tools/{tool_id}/query": { "post": { "description": "Run a retrieval tool's pipeline for one query, outside any turn, narrowed to the sources\nthe named person may read. Metered under the calling key; nothing is stored.", "operationId": "query_retrieval_tool_api_v1_knowledge_retrieval_tools__tool_id__query_post", "parameters": [ { "in": "path", "name": "tool_id", "required": true, "schema": { "title": "Tool Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalQueryRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalRunRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Query Retrieval Tool", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/retrieval-tools/{tool_id}/versions": { "get": { "description": "List one retrieval tool's versions, newest first; the cursor is a version number.", "operationId": "list_retrieval_tool_versions_api_v1_knowledge_retrieval_tools__tool_id__versions_get", "parameters": [ { "in": "path", "name": "tool_id", "required": true, "schema": { "title": "Tool Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_RetrievalToolVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Retrieval Tool Versions", "tags": [ "knowledge" ] } }, "/api/v1/knowledge/retrieval-tools/{tool_id}/versions/{version}": { "get": { "description": "Fetch one version of a retrieval tool.", "operationId": "get_retrieval_tool_version_api_v1_knowledge_retrieval_tools__tool_id__versions__version__get", "parameters": [ { "in": "path", "name": "tool_id", "required": true, "schema": { "title": "Tool Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalToolVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Retrieval Tool Version", "tags": [ "knowledge" ] } }, "/api/v1/labels": { "get": { "description": "Every tool and model this organisation has classified, by kind and name.\n\nUnpaged, deliberately: a classification exists only for a name somebody typed, so this is the\nhandful of builtins and models the organisation actually narrowed and never a page of the\ncatalogue. The labels on everything else ride on the rows their own listings already answer.\n\nListing is never audited: nothing was attempted, only asked about.", "operationId": "list_labels_api_v1_labels_get", "parameters": [ { "description": "only classifications of this kind", "in": "query", "name": "kind", "required": false, "schema": { "anyOf": [ { "enum": [ "tool", "model" ], "type": "string" }, { "type": "null" } ], "description": "only classifications of this kind", "title": "Kind" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ResourceLabelRead" }, "title": "Response List Labels Api V1 Labels Get", "type": "array" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Labels", "tags": [ "labels" ] } }, "/api/v1/labels/{kind}/{name}": { "delete": { "description": "Remove this organisation's classification of one tool or model, leaving it unclassified --\nwhich every rule over a label then fails.", "operationId": "delete_label_api_v1_labels__kind___name__delete", "parameters": [ { "in": "path", "name": "kind", "required": true, "schema": { "enum": [ "tool", "model" ], "title": "Kind", "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Label", "tags": [ "labels" ] }, "get": { "description": "This organisation's classification of one tool or model.", "operationId": "get_label_api_v1_labels__kind___name__get", "parameters": [ { "in": "path", "name": "kind", "required": true, "schema": { "enum": [ "tool", "model" ], "title": "Kind", "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLabelRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Label", "tags": [ "labels" ] }, "put": { "description": "Classify one tool or model, replacing whatever this organisation said before.\n\n`201` with a `Location` when nothing was classified under this name, `200` when something\nwas. A name no catalogue answers to is `422` on `name`, and so is a tool that has a row of\nits own -- that tool is classified where it is defined.", "operationId": "set_label_api_v1_labels__kind___name__put", "parameters": [ { "in": "path", "name": "kind", "required": true, "schema": { "enum": [ "tool", "model" ], "title": "Kind", "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLabelWrite" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLabelRead" } } }, "description": "Successful Response" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceLabelRead" } } }, "description": "Created" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Set Label", "tags": [ "labels" ] } }, "/api/v1/mail_connectors": { "get": { "description": "List the calling key's tenant's mail connectors.", "operationId": "list_mail_connectors_api_v1_mail_connectors_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_MailConnectorRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Mail Connectors", "tags": [ "mail connectors" ] }, "post": { "description": "Register a mail connector under the calling key's tenant. 503 when the deployment\nconfigures no key to seal its credential with.", "operationId": "create_mail_connector_api_v1_mail_connectors_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailConnectorCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailConnectorRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Mail Connector", "tags": [ "mail connectors" ] } }, "/api/v1/mail_connectors/{connector_id}": { "delete": { "description": "Delete a mail connector, its versions and every mail it has not sent yet.", "operationId": "delete_mail_connector_api_v1_mail_connectors__connector_id__delete", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Mail Connector", "tags": [ "mail connectors" ] }, "get": { "description": "Fetch one mail connector.", "operationId": "get_mail_connector_api_v1_mail_connectors__connector_id__get", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailConnectorRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Mail Connector", "tags": [ "mail connectors" ] }, "patch": { "description": "Update what this connector does, or its credential, mailbox or region. A change to what\nit does creates the next version; `name` never changes.", "operationId": "update_mail_connector_api_v1_mail_connectors__connector_id__patch", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailConnectorUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailConnectorRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Mail Connector", "tags": [ "mail connectors" ] } }, "/api/v1/mail_connectors/{connector_id}/authorizations": { "post": { "description": "The URL this person opens to connect their own mailbox. 409 when the connector\ndoes not log in as each person; 503 when this deployment configures no public address to send\nthem back to.", "operationId": "begin_mail_connector_authorization_api_v1_mail_connectors__connector_id__authorizations_post", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationUrlRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Begin Mail Connector Authorization", "tags": [ "mail connectors" ] } }, "/api/v1/mail_connectors/{connector_id}/authorizations/{user}": { "delete": { "description": "Forget this person's grant at this connector. Core's own copy only; the provider is never\ntold, and a person with no grant answers 204 just the same.", "operationId": "revoke_mail_connector_authorization_api_v1_mail_connectors__connector_id__authorizations__user__delete", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "the calling application's own opaque identifier of the person, the same value its `POST /responses` sends as `user`", "in": "path", "name": "user", "required": true, "schema": { "description": "the calling application's own opaque identifier of the person, the same value its `POST /responses` sends as `user`", "pattern": "^[A-Za-z0-9._:@-]{1,128}$", "title": "User", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Revoke Mail Connector Authorization", "tags": [ "mail connectors" ] }, "get": { "description": "Whether this person has connected their own mailbox, and what the grant covers.", "operationId": "get_mail_connector_authorization_api_v1_mail_connectors__connector_id__authorizations__user__get", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "the calling application's own opaque identifier of the person, the same value its `POST /responses` sends as `user`", "in": "path", "name": "user", "required": true, "schema": { "description": "the calling application's own opaque identifier of the person, the same value its `POST /responses` sends as `user`", "pattern": "^[A-Za-z0-9._:@-]{1,128}$", "title": "User", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Mail Connector Authorization", "tags": [ "mail connectors" ] } }, "/api/v1/mail_connectors/{connector_id}/test": { "post": { "description": "Log in to the IMAP server and open the first folder read-only, and greet and log in to\nthe SMTP server when the connector sends, of the latest published version or the published\n`version` named; store and send nothing. A failure is a 200 carrying `ok: false` and a fixed\ncode.", "operationId": "test_mail_connector_api_v1_mail_connectors__connector_id__test_post", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "The version to test; by default the latest published one. A key is told a draft's number is not there; the management twin tests any version a person sees", "in": "query", "name": "version", "required": false, "schema": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The version to test; by default the latest published one. A key is told a draft's number is not there; the management twin tests any version a person sees", "title": "Version" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailConnectorTestRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Test Mail Connector", "tags": [ "mail connectors" ] } }, "/api/v1/mail_connectors/{connector_id}/versions": { "get": { "description": "List one connector's versions, newest first (`order=asc` reverses it); the cursor is a\nversion number.", "operationId": "list_mail_connector_versions_api_v1_mail_connectors__connector_id__versions_get", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "keyset direction: 'desc' (newest first, the default) or 'asc'", "in": "query", "name": "order", "required": false, "schema": { "default": "desc", "description": "keyset direction: 'desc' (newest first, the default) or 'asc'", "enum": [ "asc", "desc" ], "title": "Order", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_MailConnectorVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Mail Connector Versions", "tags": [ "mail connectors" ] } }, "/api/v1/mail_connectors/{connector_id}/versions/{version}": { "get": { "description": "Fetch one version of a connector.", "operationId": "get_mail_connector_version_api_v1_mail_connectors__connector_id__versions__version__get", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailConnectorVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Mail Connector Version", "tags": [ "mail connectors" ] } }, "/api/v1/marketplace": { "get": { "description": "This deployment's catalogue of `listed` `catalogue` publications -- the key-facing twin of\n`GET /catalogue`, at a path of its own because every router here shares one path space and\n`/catalogue` is already the human route's (`app.sharing.catalogue_router`).\n\nThe operator's review queue (`?status=submitted` there) has no twin: an operator is never a\nkey.", "operationId": "list_marketplace_api_v1_marketplace_get", "parameters": [ { "in": "query", "name": "q", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_CatalogueListingRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Marketplace", "tags": [ "sharing" ] } }, "/api/v1/marketplace/{publication_id}/cover": { "get": { "description": "The listing cover of one publication of the deployment's catalogue, as bytes.", "operationId": "get_marketplace_cover_api_v1_marketplace__publication_id__cover_get", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } } }, "description": "The cover image." }, "304": { "description": "The caller's copy is current." }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Marketplace Cover", "tags": [ "sharing" ] } }, "/api/v1/mcp": { "delete": { "description": "Refuse ending a session there is none of.", "operationId": "end_mcp_session_api_v1_mcp_delete", "responses": { "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "405": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem405", "type": "object" } } }, "description": "Method Not Allowed: this endpoint keeps no session" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "End Mcp Session", "tags": [ "mcp" ] }, "get": { "description": "Refuse the standalone server-to-client stream a stateful transport would open.\n\nDeclared rather than absent so a client probing for it reads Core's own deliberate answer\ninstead of the `404` the edge gives an operation the schema does not carry -- and behind the\nsame credential as the endpoint it probes, so the contract, the edge and this route all agree\non which credential this path takes (`tests/repo/test_gateway_config.py`).", "operationId": "mcp_stream_api_v1_mcp_get", "responses": { "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "405": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem405", "type": "object" } } }, "description": "Method Not Allowed: this endpoint keeps no session" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Mcp Stream", "tags": [ "mcp" ] }, "post": { "description": "Speak the Model Context Protocol over streamable HTTP, as one tenant's API key.\n\nThe key's secret is presented as a static bearer on every request; the tools it is shown are\nthe ones its capabilities admit, and each tool call is dispatched through this API's own\nroutes, so policy, metering, audit and problem+json apply unchanged. `?tool_search=router`\nshows them behind the tool router's two tools instead, held to the key's switch and the\norganisation's ceiling (`422` on `tool_search` otherwise).", "operationId": "mcp_api_v1_mcp_post", "parameters": [ { "description": "`router` serves the tools behind the tool router's two tools, `builtin__tool_search` and `builtin__tool_run`, and needs the key's `tooling.tool_search.enabled`; `direct` or nothing serves every tool as it is", "in": "query", "name": "tool_search", "required": false, "schema": { "anyOf": [ { "enum": [ "direct", "router" ], "type": "string" }, { "type": "null" } ], "description": "`router` serves the tools behind the tool router's two tools, `builtin__tool_search` and `builtin__tool_run`, and needs the key's `tooling.tool_search.enabled`; `direct` or nothing serves every tool as it is", "title": "Tool Search" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "one JSON-RPC 2.0 request, as the Model Context Protocol's streamable HTTP transport sends it", "title": "JsonRpcRequest", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} }, "text/event-stream": { "schema": { "description": "SSE frames, each carrying one JSON-RPC message", "type": "string" } } }, "description": "the JSON-RPC response, as Server-Sent Events" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Mcp", "tags": [ "mcp" ] } }, "/api/v1/mcp/toolsets/{name}": { "delete": { "description": "Refuse ending a session there is none of.", "operationId": "end_mcp_toolset_session_api_v1_mcp_toolsets__name__delete", "parameters": [ { "description": "the toolset's name", "in": "path", "name": "name", "required": true, "schema": { "description": "the toolset's name", "maxLength": 64, "title": "Name", "type": "string" } } ], "responses": { "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "405": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem405", "type": "object" } } }, "description": "Method Not Allowed: this endpoint keeps no session" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "End Mcp Toolset Session", "tags": [ "mcp" ] }, "get": { "description": "Refuse the standalone server-to-client stream a stateful transport would open, behind the\nsame credential as the endpoint it probes.", "operationId": "mcp_toolset_stream_api_v1_mcp_toolsets__name__get", "parameters": [ { "description": "the toolset's name", "in": "path", "name": "name", "required": true, "schema": { "description": "the toolset's name", "maxLength": 64, "title": "Name", "type": "string" } } ], "responses": { "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "405": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem405", "type": "object" } } }, "description": "Method Not Allowed: this endpoint keeps no session" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Mcp Toolset Stream", "tags": [ "mcp" ] }, "post": { "description": "Speak the Model Context Protocol over streamable HTTP, as one tenant's API key, over one\nof that tenant's own toolsets.\n\nThe tools are the toolset's own expansion, resolved exactly as a turn naming that toolset\nwould resolve it, and a call runs the resolved tool's own executor under this key's scope and\npolicy (`docs/architecture/tooling.md` \"A toolset served over MCP\").\n\n`?tool_search=router` serves the group behind the tool router's two tools instead, held to\nthe key's switch and the organisation's ceiling (`422` on `tool_search` otherwise).\n\nThe expansion is resolved *before* the transport is handed the request, so a toolset this\ntenant does not have answers `404` and a group larger than a turn may carry answers `422` --\nthe route's own problem+json, as authentication already does, rather than a JSON-RPC error a\nclient would have to unwrap.", "operationId": "mcp_toolset_api_v1_mcp_toolsets__name__post", "parameters": [ { "description": "the toolset's name", "in": "path", "name": "name", "required": true, "schema": { "description": "the toolset's name", "maxLength": 64, "title": "Name", "type": "string" } }, { "description": "`router` serves the tools behind the tool router's two tools, `builtin__tool_search` and `builtin__tool_run`, and needs the key's `tooling.tool_search.enabled`; `direct` or nothing serves every tool as it is", "in": "query", "name": "tool_search", "required": false, "schema": { "anyOf": [ { "enum": [ "direct", "router" ], "type": "string" }, { "type": "null" } ], "description": "`router` serves the tools behind the tool router's two tools, `builtin__tool_search` and `builtin__tool_run`, and needs the key's `tooling.tool_search.enabled`; `direct` or nothing serves every tool as it is", "title": "Tool Search" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "one JSON-RPC 2.0 request, as the Model Context Protocol's streamable HTTP transport sends it", "title": "JsonRpcRequest", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} }, "text/event-stream": { "schema": { "description": "SSE frames, each carrying one JSON-RPC message", "type": "string" } } }, "description": "the JSON-RPC response, as Server-Sent Events" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Mcp Toolset", "tags": [ "mcp" ] } }, "/api/v1/mcp_servers": { "get": { "description": "List the calling key's tenant's registered MCP servers.", "operationId": "list_mcp_servers_api_v1_mcp_servers_get", "parameters": [ { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "name", "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_McpServerRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Mcp Servers", "tags": [ "mcp_servers" ] }, "post": { "description": "Register an MCP server under the calling key's tenant. 503 when the body carries a\ncredential and the deployment configures no key to seal it with.", "operationId": "create_mcp_server_api_v1_mcp_servers_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpServerCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpServerRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Mcp Server", "tags": [ "mcp_servers" ] } }, "/api/v1/mcp_servers/{server_id}": { "delete": { "description": "Delete a registered MCP server.", "operationId": "delete_mcp_server_api_v1_mcp_servers__server_id__delete", "parameters": [ { "in": "path", "name": "server_id", "required": true, "schema": { "title": "Server Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Mcp Server", "tags": [ "mcp_servers" ] }, "get": { "description": "Fetch one registered MCP server.", "operationId": "get_mcp_server_api_v1_mcp_servers__server_id__get", "parameters": [ { "in": "path", "name": "server_id", "required": true, "schema": { "title": "Server Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpServerRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Mcp Server", "tags": [ "mcp_servers" ] }, "patch": { "description": "Update a registered MCP server's url, allowed_tools or credential. `name` never changes,\nand an omitted `auth` leaves the stored credential alone.", "operationId": "update_mcp_server_api_v1_mcp_servers__server_id__patch", "parameters": [ { "in": "path", "name": "server_id", "required": true, "schema": { "title": "Server Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpServerUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpServerRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Mcp Server", "tags": [ "mcp_servers" ] } }, "/api/v1/mcp_servers/{server_id}/authorizations": { "post": { "description": "Ask Core for the URL this person opens to connect their own login to this server. 409\nwhen the registration's credential is not a person's own login; 503 when this deployment\nconfigures no public address to send them back to.", "operationId": "begin_mcp_server_authorization_api_v1_mcp_servers__server_id__authorizations_post", "parameters": [ { "in": "path", "name": "server_id", "required": true, "schema": { "title": "Server Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationUrlRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Begin Mcp Server Authorization", "tags": [ "mcp_servers" ] } }, "/api/v1/mcp_servers/{server_id}/authorizations/{user}": { "delete": { "description": "Forget this person's grant at this server. Core's own copy only; the provider is never\ntold, and a person with no grant answers 204 just the same.", "operationId": "revoke_mcp_server_authorization_api_v1_mcp_servers__server_id__authorizations__user__delete", "parameters": [ { "in": "path", "name": "server_id", "required": true, "schema": { "title": "Server Id", "type": "string" } }, { "description": "the calling application's own opaque identifier of the person, the same value its `POST /responses` sends as `user`", "in": "path", "name": "user", "required": true, "schema": { "description": "the calling application's own opaque identifier of the person, the same value its `POST /responses` sends as `user`", "pattern": "^[A-Za-z0-9._:@-]{1,128}$", "title": "User", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Revoke Mcp Server Authorization", "tags": [ "mcp_servers" ] }, "get": { "description": "Whether this person has connected their login to this server, and what it covers.", "operationId": "get_mcp_server_authorization_api_v1_mcp_servers__server_id__authorizations__user__get", "parameters": [ { "in": "path", "name": "server_id", "required": true, "schema": { "title": "Server Id", "type": "string" } }, { "description": "the calling application's own opaque identifier of the person, the same value its `POST /responses` sends as `user`", "in": "path", "name": "user", "required": true, "schema": { "description": "the calling application's own opaque identifier of the person, the same value its `POST /responses` sends as `user`", "pattern": "^[A-Za-z0-9._:@-]{1,128}$", "title": "User", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Mcp Server Authorization", "tags": [ "mcp_servers" ] } }, "/api/v1/mcp_servers/{server_id}/cover": { "delete": { "description": "Remove the picture on one registered MCP server.", "operationId": "delete_mcp_server_cover_api_v1_mcp_servers__server_id__cover_delete", "parameters": [ { "in": "path", "name": "server_id", "required": true, "schema": { "title": "Server Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Mcp Server Cover", "tags": [ "covers" ] }, "get": { "description": "The cover of one registered MCP server, as bytes -- the picture every tool of that server\nfalls back to.", "operationId": "get_mcp_server_cover_api_v1_mcp_servers__server_id__cover_get", "parameters": [ { "in": "path", "name": "server_id", "required": true, "schema": { "title": "Server Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } } }, "description": "The cover image." }, "304": { "description": "The caller's copy is current." }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Mcp Server Cover", "tags": [ "covers" ] }, "put": { "description": "Put a picture on one registered MCP server.", "operationId": "set_mcp_server_cover_api_v1_mcp_servers__server_id__cover_put", "parameters": [ { "in": "path", "name": "server_id", "required": true, "schema": { "title": "Server Id", "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "The image itself, as the whole body: a PNG, a JPEG or a WebP. Send its own type as `Content-Type` -- what decides acceptance is the bytes, not the header.", "required": true }, "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "415": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem415", "type": "object" } } }, "description": "Unsupported Media Type" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Set Mcp Server Cover", "tags": [ "covers" ] } }, "/api/v1/mcp_servers/{server_id}/sync": { "post": { "description": "Queue a tool sync for this registration and answer it as it stands.\n\n`202`, not `200`: the listing the worker will pull has not happened yet, and the answer's\n`last_synced_at` is still the previous sync's.", "operationId": "sync_mcp_server_api_v1_mcp_servers__server_id__sync_post", "parameters": [ { "in": "path", "name": "server_id", "required": true, "schema": { "title": "Server Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpServerRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Sync Mcp Server", "tags": [ "mcp_servers" ] } }, "/api/v1/mcp_servers/{server_id}/tools": { "get": { "description": "List a registered MCP server's tools as the last sync stored them, each flagged with\nwhether the server's own `allowed_tools` offers it. Reads rows and dials nothing, so there\nis no `503` and no egress decision here; a server that has never synced, or whose last sync\nfailed, answers an empty page and says why on `GET /mcp_servers/{server_id}`.", "operationId": "list_mcp_server_tools_api_v1_mcp_servers__server_id__tools_get", "parameters": [ { "in": "path", "name": "server_id", "required": true, "schema": { "title": "Server Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_McpToolRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Mcp Server Tools", "tags": [ "mcp_servers" ] } }, "/api/v1/mcp_servers/{server_id}/versions": { "get": { "description": "List a registered MCP server's published versions, newest first (`order=asc` reverses it);\nthe cursor is a version number.", "operationId": "list_mcp_server_versions_api_v1_mcp_servers__server_id__versions_get", "parameters": [ { "in": "path", "name": "server_id", "required": true, "schema": { "title": "Server Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "keyset direction: 'desc' (newest first, the default) or 'asc'", "in": "query", "name": "order", "required": false, "schema": { "default": "desc", "description": "keyset direction: 'desc' (newest first, the default) or 'asc'", "enum": [ "asc", "desc" ], "title": "Order", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_McpServerVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Mcp Server Versions", "tags": [ "mcp_servers" ] } }, "/api/v1/mcp_servers/{server_id}/versions/{version}": { "get": { "description": "Fetch one published version of a registered MCP server.", "operationId": "get_mcp_server_version_api_v1_mcp_servers__server_id__versions__version__get", "parameters": [ { "in": "path", "name": "server_id", "required": true, "schema": { "title": "Server Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpServerVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Mcp Server Version", "tags": [ "mcp_servers" ] } }, "/api/v1/memory": { "get": { "description": "List the tenant's memory records.", "operationId": "list_memory_api_v1_memory_get", "parameters": [ { "description": "narrow to one knowledge index", "in": "query", "name": "index_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one knowledge index", "title": "Index Id" } }, { "description": "narrow to one memory type", "in": "query", "name": "type", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one memory type", "title": "Type" } }, { "description": "metadata pairs as 'key:value'; a record must match every pair", "in": "query", "name": "metadata", "required": false, "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "metadata pairs as 'key:value'; a record must match every pair", "title": "Metadata" } }, { "description": "minimum effective (decayed) confidence", "in": "query", "name": "min_confidence", "required": false, "schema": { "anyOf": [ { "maximum": 1, "minimum": 0, "type": "number" }, { "type": "null" } ], "description": "minimum effective (decayed) confidence", "title": "Min Confidence" } }, { "description": "'current' (the default), 'superseded', 'archived', or 'all' for every record whatever its state", "in": "query", "name": "state", "required": false, "schema": { "default": "current", "description": "'current' (the default), 'superseded', 'archived', or 'all' for every record whatever its state", "enum": [ "current", "superseded", "archived", "all" ], "title": "State", "type": "string" } }, { "description": "narrow to commitments with this status", "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "enum": [ "open", "fulfilled", "cancelled" ], "type": "string" }, { "type": "null" } ], "description": "narrow to commitments with this status", "title": "Status" } }, { "description": "narrow to episodes still going on at or after this time, newest first; a record with no time span is never in a range", "in": "query", "name": "occurred_after", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "narrow to episodes still going on at or after this time, newest first; a record with no time span is never in a range", "title": "Occurred After" } }, { "description": "narrow to episodes that began at or before this time, newest first", "in": "query", "name": "occurred_before", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "narrow to episodes that began at or before this time, newest first", "title": "Occurred Before" } }, { "description": "only records created at or after this instant (ISO 8601 with offset)", "in": "query", "name": "created_after", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only records created at or after this instant (ISO 8601 with offset)", "title": "Created After" } }, { "description": "only records created before this instant (ISO 8601 with offset)", "in": "query", "name": "created_before", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only records created before this instant (ISO 8601 with offset)", "title": "Created Before" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_MemoryRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Memory", "tags": [ "memory" ] }, "post": { "description": "Write one memory record explicitly; with `supersedes`, as the correction of another.", "operationId": "create_memory_api_v1_memory_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Memory", "tags": [ "memory" ] } }, "/api/v1/memory/stores": { "get": { "description": "List the memory stores this key reaches: every index memory was written into or\nconfigured for.", "operationId": "list_memory_stores_api_v1_memory_stores_get", "parameters": [ { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_MemoryStoreRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Memory Stores", "tags": [ "memory" ] } }, "/api/v1/memory/stores/{index_id}": { "get": { "description": "Fetch one memory store's settings; an index nothing configured reads as the defaults.", "operationId": "get_memory_store_api_v1_memory_stores__index_id__get", "parameters": [ { "in": "path", "name": "index_id", "required": true, "schema": { "title": "Index Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryStoreRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Memory Store", "tags": [ "memory" ] }, "patch": { "description": "Replace the settings sections the body names; the others stay as they are. `promotion`\nneeds `management` too, in an organisation whose ceiling holds `improvements` (`403`).", "operationId": "update_memory_store_api_v1_memory_stores__index_id__patch", "parameters": [ { "in": "path", "name": "index_id", "required": true, "schema": { "title": "Index Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryStoreUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryStoreRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Memory Store", "tags": [ "memory" ] } }, "/api/v1/memory/stores/{index_id}/extraction": { "get": { "description": "Fetch a memory store's extraction switch: whether it can run, what it wrote, its\nconversation windows by state with their commonest failure, and its connector's last sync.", "operationId": "get_memory_extraction_api_v1_memory_stores__index_id__extraction_get", "parameters": [ { "in": "path", "name": "index_id", "required": true, "schema": { "title": "Index Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryExtractionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Memory Extraction", "tags": [ "memory" ] }, "put": { "description": "Switch extraction on (making or updating its collection, connector and pipeline) or off\n(removing its connector). Needs `threads` either way, and to switch it on a policy that\nallows writing memory.", "operationId": "put_memory_extraction_api_v1_memory_stores__index_id__extraction_put", "parameters": [ { "in": "path", "name": "index_id", "required": true, "schema": { "title": "Index Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryExtractionPut" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryExtractionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Put Memory Extraction", "tags": [ "memory" ] } }, "/api/v1/memory/stores/{index_id}/search": { "post": { "description": "Search one store's current records by keyword, meaning and the store's own signals.\nMeters one retrieval unit, and the query's embedding when it was embedded.", "operationId": "search_memory_store_api_v1_memory_stores__index_id__search_post", "parameters": [ { "in": "path", "name": "index_id", "required": true, "schema": { "title": "Index Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemorySearch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_MemorySearchHit_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Search Memory Store", "tags": [ "memory" ] } }, "/api/v1/memory/{memory_id}": { "delete": { "description": "Erase a memory record.", "operationId": "delete_memory_api_v1_memory__memory_id__delete", "parameters": [ { "in": "path", "name": "memory_id", "required": true, "schema": { "title": "Memory Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Memory", "tags": [ "memory" ] }, "get": { "description": "Fetch one memory record, whatever its state.", "operationId": "get_memory_api_v1_memory__memory_id__get", "parameters": [ { "in": "path", "name": "memory_id", "required": true, "schema": { "title": "Memory Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Memory", "tags": [ "memory" ] }, "patch": { "description": "Update a memory record's metadata, confidence or commitment fields in place; resets its\nage. A write, so a rule of the key's policy must permit `memory_write`.", "operationId": "update_memory_api_v1_memory__memory_id__patch", "parameters": [ { "in": "path", "name": "memory_id", "required": true, "schema": { "title": "Memory Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Memory", "tags": [ "memory" ] } }, "/api/v1/memory/{memory_id}/confirm": { "post": { "description": "Confirm a current memory record: the same fact said again, so its decay clock restarts. A\nwrite, so a rule of the key's policy must permit `memory_write`.", "operationId": "confirm_memory_api_v1_memory__memory_id__confirm_post", "parameters": [ { "in": "path", "name": "memory_id", "required": true, "schema": { "title": "Memory Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Confirm Memory", "tags": [ "memory" ] } }, "/api/v1/memory/{memory_id}/history": { "get": { "description": "A memory record's supersession chain, oldest first: what it replaced and what replaced\nit.", "operationId": "get_memory_history_api_v1_memory__memory_id__history_get", "parameters": [ { "in": "path", "name": "memory_id", "required": true, "schema": { "title": "Memory Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_MemoryRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Memory History", "tags": [ "memory" ] } }, "/api/v1/messages": { "post": { "description": "Run one turn from Anthropic's Messages request and answer Anthropic's `message`.\n\nAlways 200 when a message comes back, stored turn or not: a `message` object has no created\nstate and no `Location` to send, and the thread a stored turn joined is in\n`X-Core-Thread-Id`. `stream: true` answers `text/event-stream` in the vendor's own frames.", "operationId": "create_message_api_v1_messages_post", "parameters": [ { "in": "header", "name": "idempotency-key", "required": false, "schema": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "description": "the vendor's API date; accepted and ignored, Core has one behaviour", "in": "header", "name": "anthropic-version", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the vendor's API date; accepted and ignored, Core has one behaviour", "title": "Anthropic-Version" } }, { "description": "the vendor's beta feature list; accepted and ignored, a hint that does not change what the answer means", "in": "header", "name": "anthropic-beta", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the vendor's beta feature list; accepted and ignored, a hint that does not change what the answer means", "title": "Anthropic-Beta" } }, { "description": "continue this thread (Core), exactly as the body's `thread_id` does: for a vendor SDK client that can set default headers but not body fields. Both given and different is refused", "in": "header", "name": "X-Core-Thread-Id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "continue this thread (Core), exactly as the body's `thread_id` does: for a vendor SDK client that can set default headers but not body fields. Both given and different is refused", "title": "X-Core-Thread-Id" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagesRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageObject" } }, "text/event-stream": { "schema": { "description": "One event of a streamed message.", "oneOf": [ { "additionalProperties": false, "description": "The message this stream will fill in, before it has any content.", "properties": { "message": { "$ref": "#/components/schemas/MessageObject", "description": "the message as it stands before the turn runs: no content, no stop reason, and the id every later event belongs to" }, "type": { "const": "message_start", "default": "message_start", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "message" ], "title": "MessageStartEvent", "type": "object" }, { "additionalProperties": false, "description": "A block has begun; what follows until its `content_block_stop` belongs to it.", "properties": { "content_block": { "description": "the block itself, empty of whatever the deltas that follow will carry", "discriminator": { "mapping": { "mcp_tool_result": "#/components/schemas/MCPToolResultBlock", "mcp_tool_use": "#/components/schemas/MCPToolUseBlock", "text": "#/components/schemas/TextBlock", "thinking": "#/components/schemas/ThinkingBlock", "tool_use": "#/components/schemas/ToolUseBlock" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/TextBlock" }, { "$ref": "#/components/schemas/ThinkingBlock" }, { "$ref": "#/components/schemas/ToolUseBlock" }, { "$ref": "#/components/schemas/MCPToolUseBlock" }, { "$ref": "#/components/schemas/MCPToolResultBlock" } ], "title": "Content Block" }, "index": { "description": "position of this block in the message's content, from 0", "title": "Index", "type": "integer" }, "type": { "const": "content_block_start", "default": "content_block_start", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "index", "content_block" ], "title": "ContentBlockStartEvent", "type": "object" }, { "additionalProperties": false, "description": "More of the block at `index`.", "properties": { "delta": { "description": "what was produced since the previous delta", "oneOf": [ { "additionalProperties": false, "description": "A piece of a text block's text.", "properties": { "text": { "description": "the text produced since the previous delta", "title": "Text", "type": "string" }, "type": { "const": "text_delta", "default": "text_delta", "description": "the delta's kind", "title": "Type", "type": "string" } }, "required": [ "text" ], "title": "TextDelta", "type": "object" }, { "additionalProperties": false, "description": "A piece of a thinking block's readable summary.", "properties": { "thinking": { "description": "the summary text produced since the previous delta", "title": "Thinking", "type": "string" }, "type": { "const": "thinking_delta", "default": "thinking_delta", "description": "the delta's kind", "title": "Type", "type": "string" } }, "required": [ "thinking" ], "title": "ThinkingDelta", "type": "object" }, { "additionalProperties": false, "description": "A piece of a tool call's arguments, as JSON text.", "properties": { "partial_json": { "description": "the next fragment of the call's arguments; concatenating every fragment of one block yields the JSON object the finished block carries", "title": "Partial Json", "type": "string" }, "type": { "const": "input_json_delta", "default": "input_json_delta", "description": "the delta's kind", "title": "Type", "type": "string" } }, "required": [ "partial_json" ], "title": "InputJSONDelta", "type": "object" } ], "title": "Delta" }, "index": { "description": "position of the block this delta belongs to", "title": "Index", "type": "integer" }, "type": { "const": "content_block_delta", "default": "content_block_delta", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "index", "delta" ], "title": "ContentBlockDeltaEvent", "type": "object" }, { "additionalProperties": false, "description": "The block at `index` is finished.", "properties": { "index": { "description": "position of the block that is now complete", "title": "Index", "type": "integer" }, "type": { "const": "content_block_stop", "default": "content_block_stop", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "index" ], "title": "ContentBlockStopEvent", "type": "object" }, { "additionalProperties": false, "description": "How the message ends, and what the whole turn cost.", "properties": { "delta": { "additionalProperties": false, "description": "What `message_delta` changes about the message itself.", "properties": { "container": { "description": "always null: the vendor's code-execution container, which Core does not run", "title": "Container", "type": "null" }, "stop_details": { "anyOf": [ { "$ref": "#/components/schemas/RefusalStopDetails" }, { "type": "null" } ], "description": "structured information about a refusal, else null" }, "stop_reason": { "anyOf": [ { "enum": [ "end_turn", "max_tokens", "stop_sequence", "tool_use", "pause_turn", "refusal" ], "type": "string" }, { "type": "null" } ], "description": "why the turn stopped", "title": "Stop Reason" }, "stop_sequence": { "description": "always null: Core honours `stop_sequences`, but no provider port says which one ended the turn", "title": "Stop Sequence", "type": "null" } }, "required": [ "stop_reason" ], "title": "MessageStopDetails", "type": "object" }, "type": { "const": "message_delta", "default": "message_delta", "description": "the event's type", "title": "Type", "type": "string" }, "usage": { "additionalProperties": false, "description": "The turn's usage, cumulative, as the vendor reports it on `message_delta`.", "properties": { "cache_creation_input_tokens": { "default": 0, "description": "always 0: Core takes no prompt-cache instruction on this surface", "title": "Cache Creation Input Tokens", "type": "integer" }, "cache_read_input_tokens": { "default": 0, "description": "always 0: Core takes no prompt-cache instruction on this surface", "title": "Cache Read Input Tokens", "type": "integer" }, "input_tokens": { "description": "tokens consumed by context sent to the model", "title": "Input Tokens", "type": "integer" }, "output_tokens": { "description": "tokens the model generated", "title": "Output Tokens", "type": "integer" }, "output_tokens_details": { "description": "always null: the vendor's split of the generated tokens", "title": "Output Tokens Details", "type": "null" }, "server_tool_use": { "description": "always null: Core runs none of the vendor's server tools", "title": "Server Tool Use", "type": "null" } }, "required": [ "input_tokens", "output_tokens" ], "title": "DeltaUsage", "type": "object" } }, "required": [ "delta", "usage" ], "title": "MessageDeltaEvent", "type": "object" }, { "additionalProperties": false, "description": "The stream is over.", "properties": { "type": { "const": "message_stop", "default": "message_stop", "description": "the event's type", "title": "Type", "type": "string" } }, "title": "MessageStopEvent", "type": "object" }, { "additionalProperties": false, "description": "A sign of life on a connection a long turn has left quiet.", "properties": { "type": { "const": "ping", "default": "ping", "description": "the event's type", "title": "Type", "type": "string" } }, "title": "PingEvent", "type": "object" }, { "additionalProperties": false, "description": "Anthropic's error body, field for field.", "properties": { "error": { "$ref": "#/components/schemas/ErrorDetail", "description": "what went wrong" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the id correlating this failure with its request", "title": "Request Id" }, "type": { "const": "error", "default": "error", "description": "the object's wire type", "title": "Type", "type": "string" } }, "required": [ "error" ], "title": "ErrorEnvelope", "type": "object" } ], "title": "MessageStreamEvent" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "Method Not Allowed" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "Conflict" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorEnvelope" }, { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem500", "type": "object" } ] } }, "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem500", "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "Service Unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "Gateway Timeout" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Message", "tags": [ "messages" ] } }, "/api/v1/model-roles": { "get": { "description": "List the model calls Core makes on the calling key's behalf that no request names -- the\nsummariser and the embedding model -- each with the model it uses and where that model runs.\n\n**A role is absent when the key makes no such call.** The summariser is listed only when the\nkey's `compaction` capability is effective and its mode summarises (`window` summarises\nnothing); the embedding model only when the deployment configures one this organisation has\n(`app.providers.catalogue.Catalogue.embedding`). With no `compaction.model`, the summariser is\nthe operator's summary model, else the turn's own, and then `model`, `region` and `allowed` are\n`null`: that model is decided with the turn, and `GET /models` already places it. Not\n`/models/roles`: an OpenAI-compatible `GET /models/{model}` would answer there.\n\n`allowed` is the same decision each call is refused by -- `decide_model` over the key's\npolicy, the model's region and country, and the person's `model` rules when the request names\none -- without the turn's own `hosting.region`, which narrows one turn rather than this list.\nWhat the model does for an agent that carries its own compaction configuration is the agent's,\nread on the agent. Listing is never audited.", "operationId": "list_model_roles_api_v1_model_roles_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ModelRoleRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Model Roles", "tags": [ "models" ] } }, "/api/v1/model-routers": { "get": { "description": "List the routers of the organisation this key belongs to.", "operationId": "list_own_model_routers_api_v1_model_routers_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ModelRouterRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Model Routers", "tags": [ "model-routers" ] }, "post": { "description": "Create a router for the organisation this key belongs to.", "operationId": "create_own_model_router_api_v1_model_routers_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRouterCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRouterRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Own Model Router", "tags": [ "model-routers" ] } }, "/api/v1/model-routers/{router_id}": { "delete": { "description": "Delete a router of the organisation this key belongs to.", "operationId": "delete_own_model_router_api_v1_model_routers__router_id__delete", "parameters": [ { "in": "path", "name": "router_id", "required": true, "schema": { "title": "Router Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Own Model Router", "tags": [ "model-routers" ] }, "get": { "description": "Fetch one router of the organisation this key belongs to.", "operationId": "get_own_model_router_api_v1_model_routers__router_id__get", "parameters": [ { "in": "path", "name": "router_id", "required": true, "schema": { "title": "Router Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRouterRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Model Router", "tags": [ "model-routers" ] }, "patch": { "description": "Change a router of the organisation this key belongs to.", "operationId": "update_own_model_router_api_v1_model_routers__router_id__patch", "parameters": [ { "in": "path", "name": "router_id", "required": true, "schema": { "title": "Router Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRouterUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRouterRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Own Model Router", "tags": [ "model-routers" ] } }, "/api/v1/model-routers/{router_id}/versions": { "get": { "description": "List one router's published versions, newest first; a key never sees a draft.", "operationId": "list_own_model_router_versions_api_v1_model_routers__router_id__versions_get", "parameters": [ { "in": "path", "name": "router_id", "required": true, "schema": { "title": "Router Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ModelRouterVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Model Router Versions", "tags": [ "model-routers" ] } }, "/api/v1/model-routers/{router_id}/versions/{version}": { "get": { "description": "Fetch one published version of a router; a draft's number is not there.", "operationId": "get_own_model_router_version_api_v1_model_routers__router_id__versions__version__get", "parameters": [ { "in": "path", "name": "router_id", "required": true, "schema": { "title": "Router Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRouterVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Model Router Version", "tags": [ "model-routers" ] } }, "/api/v1/models": { "get": { "description": "List the models a turn on the calling key may call, one kind at a time: the chat models\nit may target by default, or with `kind` the image models offered to it as tools, the\nembedding models its retrieval embeds with and the audio models it may transcribe with.\n\n**Chat lists what the key may see; the other kinds list everything, each marked.** A chat\nmodel the request may not `see` is absent, one it may not `use` is `allowed` false. An image,\nembedding or audio model is reached rather than picked, so `allowed` says whether a call on it\nwould be refused.\n\nThe decision is the one a call is refused by: the key's policy and hosting regions, and the\nperson's own `model` rules when the request names one (`X-Core-Subject`, or a credential\nbound to a person). A request's own `hosting.region` narrows one turn, not this list.\n\nEach chat model carries the fallback chain this key would walk, and every model carries what\nit costs this key's organisation now (`null` when nothing prices it). The chat list also\ncarries the organisation's live routers the key may target, as entries of kind `router`, and\n-- for a key holding `agents` -- every agent it reaches as `agent:`, of kind `agent`,\nafter them (`docs/architecture/agents.md#naming-an-agent-in-model`).\n\n**The vendors' list rides beside `items`.** `data` is every chat model the key may target,\nwhole and never paged, with `object`, `has_more` (always false), `first_id` and `last_id`, so\nthe `openai` and `anthropic` SDKs list every model. For the other kinds it is empty.\n\nListing is never audited: nothing was attempted, only asked about.", "operationId": "list_models_api_v1_models_get", "parameters": [ { "description": "which models to list: chat (the default), the models a request targets by id, only those this key may target; image, the models offered as builtin__generate_image__ tools; embedding, the models retrieval embeds with; audio, the models POST /audio/transcriptions names; speech, the models POST /audio/speech names and builtin__speak__ tools speak with; decision, the models POST /decisions names and builtin__decide__ tools choose with. Every kind but chat lists every model this organisation has, each saying whether this key's policy admits it", "in": "query", "name": "kind", "required": false, "schema": { "default": "chat", "description": "which models to list: chat (the default), the models a request targets by id, only those this key may target; image, the models offered as builtin__generate_image__ tools; embedding, the models retrieval embeds with; audio, the models POST /audio/transcriptions names; speech, the models POST /audio/speech names and builtin__speak__ tools speak with; decision, the models POST /decisions names and builtin__decide__ tools choose with. Every kind but chat lists every model this organisation has, each saying whether this key's policy admits it", "enum": [ "chat", "embedding", "image", "audio", "speech", "decision" ], "title": "Kind", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelList" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Models", "tags": [ "models" ] } }, "/api/v1/organisation": { "get": { "description": "Show the organisation this key belongs to.", "operationId": "get_own_organisation_api_v1_organisation_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Organisation", "tags": [ "organisation" ] }, "patch": { "description": "Change what the organisation this key belongs to decides about itself.\n\nNine fields are its own, and five of them are decisions about its own content: `name`,\n`timezone` (the clock its prompts' time values are read on), `data_retention_days` (the window\nover the content it was sent), `trace_retention_days` (the shorter window it may give its\ntraces alone), `memory_retention_days` (how long its memory is kept, which may be longer or\nshorter than its conversations), `tracing_enabled` (whether Core records what it sends a\nmodel at all), `routing_config_id`, `assist_model` and `analysis_model` (all under the `keys`\nreservation) and `metadata`\n(the opaque document Core\nstores, returns and never reads -- what a platform keeps its own branding in,\n`docs/architecture/tenancy.md#an-organisations-own-document`). An organisation\ndoes not suspend itself, widen what it may switch on, reserve one of its own surfaces, cap its\nown spending, move itself or shorten the window its trail is kept for: any of those is `403`\nnaming the field, exactly as it is for a person administering the same organisation.\n`If-Match` carrying the `metadata_version` a read answered refuses the whole update `409`\nwhen `metadata` changed after that read.", "operationId": "update_own_organisation_api_v1_organisation_patch", "parameters": [ { "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "in": "header", "name": "If-Match", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "title": "If-Match" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Own Organisation", "tags": [ "organisation" ] } }, "/api/v1/organisation/allowed-hosts": { "get": { "description": "Show the hosts this key's own organisation allows its outbound calls to reach.\n\nThe same call `GET /tenants/{id}/allowed-hosts` is, made by the organisation's own key: a\nview over the `permit` rules over `egress_host` of the organisation's policy document, each\nentry marked `blocked` when the deployment refuses it for everybody.", "operationId": "list_own_allowed_hosts_api_v1_organisation_allowed_hosts_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllowedHostsRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Allowed Hosts", "tags": [ "organisation" ] }, "post": { "description": "Allow this key's own organisation to reach one more host, from its next call.\n\nA key adds a host for its **organisation**, never for itself: every key of the organisation\nmay then reach it, where its own rules permit that too. Refused `403` while the\norganisation's parent has reserved key management to itself, exactly as writing the policy\ndocument is. Adding a host already allowed changes nothing; the answer is the list as it\nnow stands.", "operationId": "add_own_allowed_host_api_v1_organisation_allowed_hosts_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllowedHostCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllowedHostsRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Add Own Allowed Host", "tags": [ "organisation" ] } }, "/api/v1/organisation/allowed-hosts/{host}": { "delete": { "description": "Take one host back from this key's own organisation, from its next call. `404` when no\nrule names it exactly; under the same `keys` reservation as writing the policy document.", "operationId": "remove_own_allowed_host_api_v1_organisation_allowed_hosts__host__delete", "parameters": [ { "in": "path", "name": "host", "required": true, "schema": { "title": "Host", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Remove Own Allowed Host", "tags": [ "organisation" ] } }, "/api/v1/organisation/assets": { "get": { "description": "List this key's organisation's brand images, without their bytes.\n\nAn organisation keeps at most 250, so the list is always one page of metadata rows.", "operationId": "list_own_assets_api_v1_organisation_assets_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AssetRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Assets", "tags": [ "organisation" ] } }, "/api/v1/organisation/assets/{slot}": { "delete": { "description": "Empty a slot of this key's organisation; an empty slot answers the same.\n\nIts public address stops answering once no organisation holds the same image.", "operationId": "delete_own_asset_api_v1_organisation_assets__slot__delete", "parameters": [ { "description": "The image's slot, such as logo", "in": "path", "name": "slot", "required": true, "schema": { "description": "The image's slot, such as logo", "pattern": "^[a-z][a-z0-9-]{0,31}$", "title": "Slot", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Own Asset", "tags": [ "organisation" ] }, "put": { "description": "Put a brand image in a slot of this key's organisation, replacing the one there.\n\nThe body is the image itself: PNG, JPEG or WebP, at most 512 KiB, decided by its bytes. The\nanswer names the image's public address, which changes whenever the image does.", "operationId": "put_own_asset_api_v1_organisation_assets__slot__put", "parameters": [ { "description": "The image's slot, such as logo", "in": "path", "name": "slot", "required": true, "schema": { "description": "The image's slot, such as logo", "pattern": "^[a-z][a-z0-9-]{0,31}$", "title": "Slot", "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "The image itself, as the whole body: a PNG, a JPEG or a WebP. Send its own type as `Content-Type` -- what decides acceptance is the bytes, not the header.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "415": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem415", "type": "object" } } }, "description": "Unsupported Media Type" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Put Own Asset", "tags": [ "organisation" ], "x-body-limit": { "max_bytes": 524288, "refusal": "A brand image may be at most {cap} bytes; this one is {size}." } } }, "/api/v1/organisation/email-domains": { "get": { "description": "List the email domains this key's organisation claims, and which it has proved it owns.\n\nIts sign-in providers link only addresses in a proved domain. An organisation claims at most\nfifty, so the list is always one page.", "operationId": "list_own_email_domains_api_v1_organisation_email_domains_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_EmailDomainRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Email Domains", "tags": [ "organisation" ] }, "post": { "description": "Claim an email domain for this organisation. It is not proved yet, and its sign-in\nproviders link nobody in it until it is; a domain another organisation proved cannot be\nclaimed.", "operationId": "add_own_email_domain_api_v1_organisation_email_domains_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailDomainCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailDomainRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Add Own Email Domain", "tags": [ "organisation" ] } }, "/api/v1/organisation/email-domains/{domain}": { "delete": { "description": "Give up an email domain. Nobody in it signs in through this organisation's providers any\nmore; their accounts stay, and anyone with a password keeps signing in with it.", "operationId": "delete_own_email_domain_api_v1_organisation_email_domains__domain__delete", "parameters": [ { "in": "path", "name": "domain", "required": true, "schema": { "title": "Domain", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Own Email Domain", "tags": [ "organisation" ] } }, "/api/v1/organisation/email-domains/{domain}/verify": { "post": { "description": "Prove this organisation owns an email domain, by the TXT record the claim names.\n\nPublish `proof_record_value` as a TXT record at `proof_record_name` first. Once proved, this\norganisation's sign-in providers may link addresses in the domain, and no other organisation\ncan prove it. Asking again for a proved domain changes nothing and answers it as it is.", "operationId": "verify_own_email_domain_api_v1_organisation_email_domains__domain__verify_post", "parameters": [ { "in": "path", "name": "domain", "required": true, "schema": { "title": "Domain", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailDomainRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Verify Own Email Domain", "tags": [ "organisation" ] } }, "/api/v1/organisation/key-policy/default": { "get": { "description": "Show a key's default document: the rules and settings a key registered without a policy\nstores. It writes no rule over hosts, so such a key reaches the hosts its organisation\npermits and narrows them only by naming its own; it permits no memory write, and holds a\nperson to her own rows and the shared ones.\n\nThe same call `GET /tenants/{id}/key-policy/default` is, and as readable by any key\n([Subjects](docs/architecture/subjects.md) \"The default rules\").", "operationId": "get_own_default_key_policy_api_v1_organisation_key_policy_default_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyDocument" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Default Key Policy", "tags": [ "organisation" ] } }, "/api/v1/organisation/label-copy": { "post": { "description": "Ask the worker to copy, once more, the `metadata` keys this key's own organisation's rules\nname into its data rows' `labels` -- the twin of `POST /tenants/{id}/label-copy`. The next\n`labels.copy` pass runs it and copies only what is still owed; what it copied is a\n`tenant.labels_copied` control event.", "operationId": "request_own_label_copy_api_v1_organisation_label_copy_post", "responses": { "202": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Request Own Label Copy", "tags": [ "organisation" ] } }, "/api/v1/organisation/label-vocabulary": { "delete": { "description": "Take this organisation's declaration away, admitting every label name, attribute name and\nvalue again wherever one is written.", "operationId": "delete_own_label_vocabulary_api_v1_organisation_label_vocabulary_delete", "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Own Label Vocabulary", "tags": [ "organisation" ] }, "get": { "description": "Show the labels and attributes this key's own organisation declared, or `null` when it\ndeclared none.\n\nThe one route of this router behind `KeyScopeDep` alone, and deliberately: **every** key of\nthe organisation may read this, not only one holding `management`. A key that writes a label\non a prompt, on a collection or through `PUT /labels/{kind}/{name}` is refused `422` for a\nname the organisation did not declare, so it has to be able to find out what the names are --\nwithholding the vocabulary from the credentials it is enforced against would be a rule nobody\ncan read. Writing it stays `management`'s, below.\n\nA credential bound to one person reaches nothing under `/organisation` at all\n(`app.subjects.reach`): what an organisation's vocabulary is, is administration, and a device\nholding a subject token is not administering anything.", "operationId": "get_own_label_vocabulary_api_v1_organisation_label_vocabulary_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LabelVocabularyRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Label Vocabulary", "tags": [ "organisation" ] }, "put": { "description": "Declare, for this key's own organisation, which labels its rules may read, which of them a\nrequest may assert and which values each admits -- whole.\n\nA key declares for its **organisation**, never for itself, exactly as it writes that\norganisation's policy document: the declaration binds every key the organisation has, this\none included. Refused `403` while this organisation's parent has reserved key management to\nitself, as registering a key is. A declaration this organisation's own rows already\ncontradict is refused with the whole list under `conflicts`, and nothing is stored.", "operationId": "put_own_label_vocabulary_api_v1_organisation_label_vocabulary_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LabelVocabulary" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LabelVocabularyRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Put Own Label Vocabulary", "tags": [ "organisation" ] } }, "/api/v1/organisation/markups": { "get": { "description": "List this key's own organisation's markups, each subject's current one first.\n\nNever an organisation above it: a parent's `descendants` markup is already inside the price\nthis organisation reads, and nothing on the wire says so.", "operationId": "list_own_markups_api_v1_organisation_markups_get", "parameters": [ { "description": "narrow to 'self' or to 'descendants'", "in": "query", "name": "scope", "required": false, "schema": { "anyOf": [ { "enum": [ "self", "descendants" ], "type": "string" }, { "type": "null" } ], "description": "narrow to 'self' or to 'descendants'", "title": "Scope" } }, { "description": "narrow to one usage kind", "in": "query", "name": "kind", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one usage kind", "title": "Kind" } }, { "description": "narrow to one model id", "in": "query", "name": "model", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one model id", "title": "Model" } }, { "description": "narrow to one tool name", "in": "query", "name": "tool_name", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one tool name", "title": "Tool Name" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_MarkupRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Markups", "tags": [ "organisation" ] }, "post": { "description": "Put a markup on what this key's own organisation is charged, for itself or for everything\nbelow it.\n\nThe same call `POST /tenants/{id}/markups` is, made by the organisation's own key instead of\nby a person administering it ([Tenancy](docs/architecture/tenancy.md) \"The key-facing\ntwins\"). A markup is this organisation's own charge outward and not a ceiling over it, so no\nparent's permission is asked for here any more than it is there\n(`app.audit.markups_router`, module docstring). One `tenant.markup_set` control event, as on\nthe person's route, attributed to this key's own id.", "operationId": "create_own_markup_api_v1_organisation_markups_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkupCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkupRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Own Markup", "tags": [ "organisation" ] } }, "/api/v1/organisation/markups/{markup_id}": { "delete": { "description": "Take one of this organisation's markups back; every figure is resolved against what\nremains, which is why this leaves a `tenant.markup_deleted` control event.", "operationId": "delete_own_markup_api_v1_organisation_markups__markup_id__delete", "parameters": [ { "in": "path", "name": "markup_id", "required": true, "schema": { "title": "Markup Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Own Markup", "tags": [ "organisation" ] }, "get": { "description": "One of this organisation's markups by id -- what the `Location` of a fresh one names.", "operationId": "get_own_markup_api_v1_organisation_markups__markup_id__get", "parameters": [ { "in": "path", "name": "markup_id", "required": true, "schema": { "title": "Markup Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkupRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Markup", "tags": [ "organisation" ] } }, "/api/v1/organisation/metadata": { "get": { "description": "Show the opaque document this key's own organisation attached to itself -- what a platform\nkeeps its own branding in, since Core stores it, returns it and never reads it\n(`docs/architecture/tenancy.md#an-organisations-own-document`).\n\nBehind no capability at all, unlike every other route under `/organisation`, and the one\nroute of this whole subtree a subject token reaches too (`app.subjects.reach`): a platform's\nfrontend has to be able to read its own branding with the key it calls with, or with the\nsubject token it hands a browser, neither of which need hold `management` to ask this one\nquestion.", "operationId": "get_own_organisation_metadata_api_v1_organisation_metadata_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationMetadataRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Organisation Metadata", "tags": [ "organisation" ] } }, "/api/v1/organisation/metadata/effective": { "get": { "description": "Show this key's own organisation's document with every key it lacks that an organisation\nabove it lends (`inheritable_keys`), in one call however deep the tree.\n\nReadable as `GET /organisation/metadata` is, by any key of the organisation and by a subject\ntoken. Every lender sits above what a key of this organisation reaches, so each key of\n`inherited_from` answers `null`; `GET /organisations/{id}/metadata/effective` from a key\nabove names them.", "operationId": "get_own_effective_metadata_api_v1_organisation_metadata_effective_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EffectiveMetadataRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Effective Metadata", "tags": [ "organisation" ] } }, "/api/v1/organisation/model-references": { "get": { "description": "List where the calling key's own organisation still names a deprecated model: the list\n`GET /tenants/{tenant_id}/model-references` answers a person administering it, read by a key\nholding `management`. Listing is never audited.", "operationId": "list_own_model_references_api_v1_organisation_model_references_get", "parameters": [ { "description": "narrow the list to one catalogue model, deprecated or not; left out, every model the catalogue deprecates. A model this organisation's catalogue does not hold lists nothing", "in": "query", "name": "model", "required": false, "schema": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "description": "narrow the list to one catalogue model, deprecated or not; left out, every model the catalogue deprecates. A model this organisation's catalogue does not hold lists nothing", "title": "Model" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ModelReferenceRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Model References", "tags": [ "models" ] } }, "/api/v1/organisation/policy": { "delete": { "description": "Take this organisation's own document away, leaving every one of its keys decided against\nits own registered document alone, and the organisation reaching no host: the hosts the\ndocument permitted go with it. `If-Match` holds it to the version a read answered.", "operationId": "delete_own_organisation_policy_api_v1_organisation_policy_delete", "parameters": [ { "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "in": "header", "name": "If-Match", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "title": "If-Match" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Own Organisation Policy", "tags": [ "organisation" ] }, "get": { "description": "Show the policy document this key's own organisation wrote for itself, or `null`.\n\nThe same call `GET /tenants/{id}/policy` is, made by the organisation's own key instead of by\na person administering it ([Tenancy](docs/architecture/tenancy.md) \"The key-facing twins\").\n`GET /key` is the other question and is unchanged: it answers the calling key's own document,\nwhich is what this key narrowed for itself, not what its organisation decided for everybody.", "operationId": "get_own_organisation_policy_api_v1_organisation_policy_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationPolicyRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Organisation Policy", "tags": [ "organisation" ] }, "put": { "description": "Replace the document this key's own organisation decides all of its keys by, whole.\n\nA key writes for its **organisation**, never for itself: the document it writes binds every\nkey the organisation has, this one included. It is therefore **not a ceiling over the key\nthat may write it**: a credential holding `management` may widen what it wrote a moment ago,\nexactly as an administrator of the organisation may. The one thing no key can ever exceed is\nits **own** registered document, which only whoever registers keys can change. A credential\nthat must not widen the organisation's ceiling is one that is not given `management` -- or one\nwhose organisation's parent has reserved key management to itself, which refuses this route\n`403` as it refuses registering a key. `If-Match` carrying the `version` a read answered\nrefuses the write `409` when the stored document changed after that read.", "operationId": "put_own_organisation_policy_api_v1_organisation_policy_put", "parameters": [ { "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "in": "header", "name": "If-Match", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "title": "If-Match" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationPolicyRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Put Own Organisation Policy", "tags": [ "organisation" ] } }, "/api/v1/organisation/policy/decisions": { "post": { "description": "Try a policy document before `PUT /organisation/policy` writes it: each question -- up to\n50 -- is answered as a request of the named key of this organisation would be, once under the\ndocument sent and once under the published one, naming the document and the rule that\ndecided. A host is answered with the regions and the block list and is not dialled.\n\nThe document is refused exactly as the `PUT` would refuse it, with the same status and fields.\nNothing is written. A key never names a stored draft; drafts are a person's.", "operationId": "try_own_organisation_policy_api_v1_organisation_policy_decisions_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyDocumentDecisionsAsk" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyDocumentDecisionsRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Try Own Organisation Policy", "tags": [ "organisation" ] } }, "/api/v1/organisation/policy/default": { "get": { "description": "Show the organisation's default document: what an organisation that wrote none is decided\nunder, and what the editor starts from. It permits every kind whole, so it narrows nothing a\nkey may reach, except the two that send data out: it names no `egress_host` and no\n`share_link`, so the organisation reaches no host and shares no page through a link until\na rule permits it.\n\nThe same call `GET /tenants/{id}/policy/default` is. Any key may read it: it names no\norganisation's data and writes nothing, and a client building a document to `PUT` starts from\nit ([Tenancy](docs/architecture/tenancy.md) \"The organisation's policy document\").", "operationId": "get_own_default_organisation_policy_api_v1_organisation_policy_default_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyDocument" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Default Organisation Policy", "tags": [ "organisation" ] } }, "/api/v1/organisation/policy/versions": { "get": { "description": "List the published versions of this key's own organisation's policy document.", "operationId": "list_own_organisation_policy_versions_api_v1_organisation_policy_versions_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_OrganisationPolicyVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Organisation Policy Versions", "tags": [ "organisation" ] } }, "/api/v1/organisation/policy/versions/{version}": { "get": { "description": "Fetch one published version of this key's own organisation's policy document.", "operationId": "get_own_organisation_policy_version_api_v1_organisation_policy_versions__version__get", "parameters": [ { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationPolicyVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Organisation Policy Version", "tags": [ "organisation" ] } }, "/api/v1/organisation/sign-in-providers": { "get": { "description": "List the providers this key's organisation's administrators may sign in through.\n\nAn organisation holds at most ten, so the list is always one page.", "operationId": "list_own_sign_in_providers_api_v1_organisation_sign_in_providers_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_SignInProviderRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Sign In Providers", "tags": [ "organisation" ] } }, "/api/v1/organisation/sign-in-providers/{name}": { "delete": { "description": "Stop this organisation's administrators signing in through this provider.\n\nTheir accounts stay: anyone who also has a password keeps signing in with it.", "operationId": "delete_own_sign_in_provider_api_v1_organisation_sign_in_providers__name__delete", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Own Sign In Provider", "tags": [ "organisation" ] }, "get": { "description": "Show one of this organisation's sign-in providers, and what to register at it.", "operationId": "get_own_sign_in_provider_api_v1_organisation_sign_in_providers__name__get", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignInProviderRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Sign In Provider", "tags": [ "organisation" ] }, "put": { "description": "Let this organisation's administrators sign in through its own identity provider, or\nreplace the one of this name.\n\nOnly someone this organisation already made an administrator can sign in this way, matched on\nthe email address the provider has verified; nobody gets an account by signing in. The\nprovider is trusted for the second factor too. The answer says which redirect URI to register\nat the provider, and the client secret is never answered back.", "operationId": "put_own_sign_in_provider_api_v1_organisation_sign_in_providers__name__put", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OidcSignInProviderCreate" }, { "$ref": "#/components/schemas/GoogleSignInProviderCreate" }, { "$ref": "#/components/schemas/EntraSignInProviderCreate" } ], "title": "Body" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignInProviderRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Put Own Sign In Provider", "tags": [ "organisation" ] } }, "/api/v1/organisation/subject-issuers": { "get": { "description": "List the identity providers this key's own organisation vouches for.\n\nThe same call `GET /tenants/{id}/subject-issuers` is, made by the organisation's own key\ninstead of by a person administering it ([Tenancy](docs/architecture/tenancy.md) \"The\nkey-facing twins\").", "operationId": "get_own_subject_issuers_api_v1_organisation_subject_issuers_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubjectIssuersRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Subject Issuers", "tags": [ "organisation" ] }, "put": { "description": "Replace the identity providers this key's own organisation vouches for, whole.\n\nA key registers an issuer for its **organisation**, never for itself: whose assertions a\ntenant believes is the organisation's decision, so one credential cannot widen it for the\nothers. Refused `403` while this organisation's parent has reserved key management to itself,\nexactly as registering a key is.", "operationId": "put_own_subject_issuers_api_v1_organisation_subject_issuers_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubjectIssuersUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubjectIssuersRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Put Own Subject Issuers", "tags": [ "organisation" ] } }, "/api/v1/organisations": { "get": { "description": "List this key's own organisation and everything below it.\n\n`parent_id` narrows the page to one organisation's direct children -- one level, which is how\na tree is drawn -- and answers 404 for an organisation this key does not reach.", "operationId": "list_organisations_api_v1_organisations_get", "parameters": [ { "description": "list only the organisations directly under this one; omit for this key's own organisation and every organisation below it", "in": "query", "name": "parent_id", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "list only the organisations directly under this one; omit for this key's own organisation and every organisation below it", "title": "Parent Id" } }, { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "key:value pairs the organisation's own metadata must hold as string values; all must match. A key it only inherits from an organisation above never matches", "in": "query", "name": "metadata", "required": false, "schema": { "description": "key:value pairs the organisation's own metadata must hold as string values; all must match. A key it only inherits from an organisation above never matches", "items": { "type": "string" }, "title": "Metadata", "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_TenantRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Organisations", "tags": [ "organisation" ] }, "post": { "description": "Create an organisation under this key's own, or under one already below it.\n\n`parent_id` names which, and is required: a key may create under any organisation it\nreaches, so which one is a real choice and not one Core can make for it. A null `parent_id`\nasks for an organisation that sits under nothing, which is an operator's alone (`403`), and\nso is naming a `database_ref`: a key is never an operator, so it always lives on the database\nits named parent's own defaults to, and sending the field anyway is `403`. `isolation` is the\nnew organisation's own and needs nobody's permission. `permitted_capabilities` must be\ninside the named parent's own ceiling (`403` naming the first one\noutside it); left out, it *is* that parent's ceiling, so a key never widens what it holds by\nomitting a field. The key administers what it created from the moment this answers, because\nthe closure is what gives it reach. `status` is `provisioning` until the background job\nfinishes.", "operationId": "create_organisation_api_v1_organisations_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Organisation", "tags": [ "organisation" ] } }, "/api/v1/organisations/{organisation_id}": { "delete": { "description": "Erase an organisation below this key's own, and everything it owns.\n\nNever the key's own organisation: that is `403`, as it is for the administrator of an\norganisation it only *is*. An organisation that still has live organisations under it is\nrefused `409` -- erasure never cascades, so they are erased first. `status` is `deleting`\nuntil the background job finishes. Its sign-in providers are removed first; when that cannot\nbe confirmed the answer is `503`, nothing is erased, and the request may be sent again.", "operationId": "delete_organisation_api_v1_organisations__organisation_id__delete", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Organisation", "tags": [ "organisation" ] }, "get": { "description": "Show one organisation this key administers.", "operationId": "get_organisation_api_v1_organisations__organisation_id__get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Organisation", "tags": [ "organisation" ] }, "patch": { "description": "Update one organisation below this key's own: its name, its status, what it may switch on,\nwhat its own administrators may not do, and what it may spend in a month.\n\nOn the key's *own* organisation only what an organisation decides about itself is allowed --\nits name, its trace retention window, its timezone (`app.tenants.access.check_update_allowed`)\n-- and every parent-only or operator-only field is `403` naming itself, the same answer\n`PATCH /organisation` gives, because it is the same call, `If-Match` included.", "operationId": "update_organisation_api_v1_organisations__organisation_id__patch", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "in": "header", "name": "If-Match", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "title": "If-Match" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Organisation", "tags": [ "organisation" ] } }, "/api/v1/organisations/{organisation_id}/admins": { "get": { "description": "List the people who administer one organisation this key administers.\n\nAn organisation nobody administers yet answers an empty page; it is a real state, not an\nerror. Someone whose invitation stopped half way is listed with `active: false` rather than\nleft out: they are there to be repaired, and re-sending their invitation is the repair.", "operationId": "list_organisation_admins_api_v1_organisations__organisation_id__admins_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_TenantAdminRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Organisation Admins", "tags": [ "organisation" ] }, "post": { "description": "Invite someone to administer one organisation below this key's own, and email them how to\nget started.\n\nSomeone who already has an account keeps it -- they are added to this organisation rather than\ngiven a second one, and `created` says which happened. The invitation email is sent by the\nsign-in service itself, so Core never sets or sees a password; when it could not be sent, the\nperson is an administrator all the same and `invite_sent` is false.", "operationId": "invite_organisation_admin_api_v1_organisations__organisation_id__admins_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantAdminCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantAdminInvited" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Invite Organisation Admin", "tags": [ "organisation" ] } }, "/api/v1/organisations/{organisation_id}/admins/{user_id}": { "delete": { "description": "Take this person's administration of this organisation away.\n\nTheir account itself is untouched: they may administer another organisation, or sign in for\nanother reason entirely. Removing the last administrator is allowed -- Core does not decide\nthat an organisation must keep one.", "operationId": "remove_organisation_admin_api_v1_organisations__organisation_id__admins__user_id__delete", "parameters": [ { "in": "path", "name": "user_id", "required": true, "schema": { "title": "User Id", "type": "string" } }, { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Remove Organisation Admin", "tags": [ "organisation" ] } }, "/api/v1/organisations/{organisation_id}/admins/{user_id}/invite": { "post": { "description": "Email this administrator their invitation again, and repair what the first one left.\n\nThe retry for an invitation that never arrived. It also puts back anything an interrupted\ninvitation did not finish, so an administrator listed as not yet `active` becomes active\nagain; doing it twice changes nothing. `invite_sent` is false when this deployment cannot send\nemail, and when the person has already finished everything the invitation asked of them.", "operationId": "resend_organisation_admin_invite_api_v1_organisations__organisation_id__admins__user_id__invite_post", "parameters": [ { "in": "path", "name": "user_id", "required": true, "schema": { "title": "User Id", "type": "string" } }, { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantAdminInviteSent" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Resend Organisation Admin Invite", "tags": [ "organisation" ] } }, "/api/v1/organisations/{organisation_id}/audit/events": { "get": { "description": "List a descendant organisation's audit events -- the key-facing twin of\n`GET /tenants/{tenant_id}/audit/events` for a key holding `management`.", "operationId": "list_organisation_audit_events_api_v1_organisations__organisation_id__audit_events_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "narrow to one request id", "in": "query", "name": "request_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one request id", "title": "Request Id" } }, { "description": "narrow to one response id", "in": "query", "name": "response_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one response id", "title": "Response Id" } }, { "description": "narrow to one event name", "in": "query", "name": "event", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one event name", "title": "Event" } }, { "description": "narrow to the rows written for one person, by the id the calling application named them with; exact match, never a prefix", "in": "query", "name": "subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to the rows written for one person, by the id the calling application named them with; exact match, never a prefix", "title": "Subject" } }, { "description": "narrow to the events Core recorded itself (`core`) or to those a product built on Core delivered (`product`)", "in": "query", "name": "origin", "required": false, "schema": { "anyOf": [ { "enum": [ "core", "product" ], "type": "string" }, { "type": "null" } ], "description": "narrow to the events Core recorded itself (`core`) or to those a product built on Core delivered (`product`)", "title": "Origin" } }, { "description": "narrow to the events one product delivered, by its namespace", "in": "query", "name": "product", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z][a-z0-9]{1,15}$", "type": "string" }, { "type": "null" } ], "description": "narrow to the events one product delivered, by its namespace", "title": "Product" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "in": "query", "name": "order", "required": false, "schema": { "default": "asc", "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "enum": [ "asc", "desc" ], "title": "Order", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AuditEventRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Organisation Audit Events", "tags": [ "usage", "audit" ] } }, "/api/v1/organisations/{organisation_id}/audit/events/export": { "get": { "description": "The same export for a key holding `management`, resource denials included, exactly as an\noperator or tenant admin's own export is -- the key-facing twin of\n`GET /tenants/{tenant_id}/audit/events/export`.", "operationId": "export_organisation_audit_events_api_v1_organisations__organisation_id__audit_events_export_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "resume after this audit event: the `id` on the last whole line a broken download delivered; only later rows are sent", "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "resume after this audit event: the `id` on the last whole line a broken download delivered; only later rows are sent", "title": "After" } }, { "description": "narrow to one request id", "in": "query", "name": "request_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one request id", "title": "Request Id" } }, { "description": "narrow to one response id", "in": "query", "name": "response_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one response id", "title": "Response Id" } }, { "description": "narrow to one event name", "in": "query", "name": "event", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one event name", "title": "Event" } }, { "description": "narrow to the rows written for one person, by the id the calling application named them with; exact match, never a prefix", "in": "query", "name": "subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to the rows written for one person, by the id the calling application named them with; exact match, never a prefix", "title": "Subject" } }, { "description": "narrow to the events Core recorded itself (`core`) or to those a product built on Core delivered (`product`)", "in": "query", "name": "origin", "required": false, "schema": { "anyOf": [ { "enum": [ "core", "product" ], "type": "string" }, { "type": "null" } ], "description": "narrow to the events Core recorded itself (`core`) or to those a product built on Core delivered (`product`)", "title": "Origin" } }, { "description": "narrow to the events one product delivered, by its namespace", "in": "query", "name": "product", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z][a-z0-9]{1,15}$", "type": "string" }, { "type": "null" } ], "description": "narrow to the events one product delivered, by its namespace", "title": "Product" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "application/x-ndjson": { "schema": { "description": "One AuditEventRead object per line, oldest first, as JSON Lines.", "title": "AuditEventExport", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Export Organisation Audit Events", "tags": [ "usage", "audit" ] } }, "/api/v1/organisations/{organisation_id}/available-publications": { "get": { "description": "List what one organisation this key administers may install.", "operationId": "list_organisation_available_publications_api_v1_organisations__organisation_id__available_publications_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_PublicationRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Organisation Available Publications", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/available-publications/{publication_id}": { "get": { "description": "Show one publication one organisation this key administers may install.", "operationId": "get_organisation_available_publication_api_v1_organisations__organisation_id__available_publications__publication_id__get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailablePublicationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Organisation Available Publication", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/available-publications/{publication_id}/cover": { "get": { "description": "The listing cover of one publication one organisation this key administers may install.", "operationId": "get_organisation_available_publication_cover_api_v1_organisations__organisation_id__available_publications__publication_id__cover_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } } }, "description": "The cover image." }, "304": { "description": "The caller's copy is current." }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Organisation Available Publication Cover", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/control-events": { "get": { "description": "List the lifecycle events of one organisation this key administers: what\n`GET /control-events` lists for the key's own and `GET /tenants/{id}/control-events` lists\nfor a person, with a draft's number left out as on the key's own trail.", "operationId": "list_child_organisation_control_events_api_v1_organisations__organisation_id__control_events_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "in": "query", "name": "order", "required": false, "schema": { "default": "asc", "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "enum": [ "asc", "desc" ], "title": "Order", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ControlEventRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Child Organisation Control Events", "tags": [ "control-events", "organisation" ] } }, "/api/v1/organisations/{organisation_id}/exports": { "get": { "description": "List the exports of an organisation this key reaches.", "operationId": "list_organisation_exports_api_v1_organisations__organisation_id__exports_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "in": "query", "name": "order", "required": false, "schema": { "default": "asc", "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "enum": [ "asc", "desc" ], "title": "Order", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ExportRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Organisation Exports", "tags": [ "exports" ] }, "post": { "description": "Queue an archive of an organisation this key reaches, or of one person in it.", "operationId": "create_organisation_export_api_v1_organisations__organisation_id__exports_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportCreate" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Organisation Export", "tags": [ "exports" ] } }, "/api/v1/organisations/{organisation_id}/exports/{export_id}": { "get": { "description": "One export of an organisation this key reaches.", "operationId": "get_organisation_export_api_v1_organisations__organisation_id__exports__export_id__get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "export_id", "required": true, "schema": { "title": "Export Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Organisation Export", "tags": [ "exports" ] } }, "/api/v1/organisations/{organisation_id}/exports/{export_id}/download": { "get": { "description": "Stream the archive of an export of an organisation this key reaches.", "operationId": "download_organisation_export_api_v1_organisations__organisation_id__exports__export_id__download_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "export_id", "required": true, "schema": { "title": "Export Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "application/zip": { "schema": { "description": "The archive: a zip whose manifest.json names the format, every file with its row count, and what the archive does not contain.", "format": "binary", "title": "TenantExportArchive", "type": "string" } } }, "description": "Successful Response" }, "206": { "content": { "application/zip": { "schema": { "description": "The archive: a zip whose manifest.json names the format, every file with its row count, and what the archive does not contain.", "format": "binary", "title": "TenantExportArchive", "type": "string" } } }, "description": "Partial Content" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "416": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem416", "type": "object" } } }, "description": "Requested Range Not Satisfiable" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Download Organisation Export", "tags": [ "exports" ] } }, "/api/v1/organisations/{organisation_id}/keys": { "get": { "description": "List the API keys of one organisation this key administers.", "operationId": "list_organisation_keys_api_v1_organisations__organisation_id__keys_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_KeyRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Organisation Keys", "tags": [ "organisation" ] }, "post": { "description": "Issue an API key for one organisation this key administers. The secret is in this response\nand nowhere else, and it is how anything is done *inside* that organisation.", "operationId": "register_organisation_key_api_v1_organisations__organisation_id__keys_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyIssued" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Register Organisation Key", "tags": [ "organisation" ] } }, "/api/v1/organisations/{organisation_id}/keys/{key_id}": { "delete": { "description": "Deregister one key of an organisation this key administers.", "operationId": "delete_organisation_key_api_v1_organisations__organisation_id__keys__key_id__delete", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Organisation Key", "tags": [ "organisation" ] }, "get": { "description": "Show one key of an organisation this key administers.", "operationId": "get_organisation_key_api_v1_organisations__organisation_id__keys__key_id__get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Organisation Key", "tags": [ "organisation" ] }, "patch": { "description": "Update one key of an organisation this key administers. `If-Match` holds the update to\nthe `policy_version` a read answered.", "operationId": "update_organisation_key_api_v1_organisations__organisation_id__keys__key_id__patch", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } }, { "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "in": "header", "name": "If-Match", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "title": "If-Match" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Organisation Key", "tags": [ "organisation" ] } }, "/api/v1/organisations/{organisation_id}/keys/{key_id}/callback-secret": { "post": { "description": "Create the callback secret of one key of an organisation this key administers, or\nreplace the one it has, and answer it once.", "operationId": "create_organisation_key_callback_secret_api_v1_organisations__organisation_id__keys__key_id__callback_secret_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyCallbackSecret" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Organisation Key Callback Secret", "tags": [ "organisation" ] } }, "/api/v1/organisations/{organisation_id}/keys/{key_id}/disable": { "post": { "description": "Disable one key of an organisation this key administers until it is enabled again.", "operationId": "disable_organisation_key_api_v1_organisations__organisation_id__keys__key_id__disable_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Disable Organisation Key", "tags": [ "organisation" ] } }, "/api/v1/organisations/{organisation_id}/keys/{key_id}/enable": { "post": { "description": "Enable one disabled key of an organisation this key administers again.", "operationId": "enable_organisation_key_api_v1_organisations__organisation_id__keys__key_id__enable_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Enable Organisation Key", "tags": [ "organisation" ] } }, "/api/v1/organisations/{organisation_id}/keys/{key_id}/rotate": { "post": { "description": "Replace the secret of one key of an organisation this key administers.", "operationId": "rotate_organisation_key_api_v1_organisations__organisation_id__keys__key_id__rotate_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "key_id", "required": true, "schema": { "title": "Key Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyRotate" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyIssued" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Rotate Organisation Key", "tags": [ "organisation" ] } }, "/api/v1/organisations/{organisation_id}/label-vocabulary": { "delete": { "description": "Take the declaration of one organisation this key administers away, admitting every label\nname, attribute name and value there again wherever one is written.", "operationId": "delete_child_label_vocabulary_api_v1_organisations__organisation_id__label_vocabulary_delete", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Child Label Vocabulary", "tags": [ "organisation" ] }, "get": { "description": "Show the labels and attributes one organisation this key administers declared, or `null`\nwhen it declared none: the same call `GET /tenants/{id}/label-vocabulary` is.", "operationId": "get_child_label_vocabulary_api_v1_organisations__organisation_id__label_vocabulary_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LabelVocabularyRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Child Label Vocabulary", "tags": [ "organisation" ] }, "put": { "description": "Declare, for one organisation this key administers, which labels its rules may read, which\nof them a request may assert and which values each admits -- whole, as\n`PUT /tenants/{id}/label-vocabulary` does. A reservation of key management binds the\norganisation it was set on, never the one above that set it. A declaration that\norganisation's own rows already contradict is refused with the whole list under `conflicts`,\nand nothing is stored.", "operationId": "put_child_label_vocabulary_api_v1_organisations__organisation_id__label_vocabulary_put", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LabelVocabulary" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LabelVocabularyRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Put Child Label Vocabulary", "tags": [ "organisation" ] } }, "/api/v1/organisations/{organisation_id}/metadata/effective": { "get": { "description": "Show the effective document of an organisation this key administers, naming each lender\nthis key reaches -- the twin of `GET /tenants/{id}/metadata/effective`.", "operationId": "get_child_effective_metadata_api_v1_organisations__organisation_id__metadata_effective_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EffectiveMetadataRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Child Effective Metadata", "tags": [ "organisation" ] } }, "/api/v1/organisations/{organisation_id}/model-routers": { "get": { "description": "List the routers of one organisation this key administers.", "operationId": "list_organisation_model_routers_api_v1_organisations__organisation_id__model_routers_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ModelRouterRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Organisation Model Routers", "tags": [ "model-routers" ] }, "post": { "description": "Create a router for one organisation this key administers.", "operationId": "create_organisation_model_router_api_v1_organisations__organisation_id__model_routers_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRouterCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRouterRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Organisation Model Router", "tags": [ "model-routers" ] } }, "/api/v1/organisations/{organisation_id}/model-routers/{router_id}": { "delete": { "description": "Delete a router of one organisation this key administers.", "operationId": "delete_organisation_model_router_api_v1_organisations__organisation_id__model_routers__router_id__delete", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "router_id", "required": true, "schema": { "title": "Router Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Organisation Model Router", "tags": [ "model-routers" ] }, "get": { "description": "Fetch one router of one organisation this key administers.", "operationId": "get_organisation_model_router_api_v1_organisations__organisation_id__model_routers__router_id__get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "router_id", "required": true, "schema": { "title": "Router Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRouterRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Organisation Model Router", "tags": [ "model-routers" ] }, "patch": { "description": "Change a router of one organisation this key administers.", "operationId": "update_organisation_model_router_api_v1_organisations__organisation_id__model_routers__router_id__patch", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "router_id", "required": true, "schema": { "title": "Router Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRouterUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRouterRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Organisation Model Router", "tags": [ "model-routers" ] } }, "/api/v1/organisations/{organisation_id}/model-routers/{router_id}/versions": { "get": { "description": "List one router's published versions, newest first; a key never sees a draft.", "operationId": "list_organisation_model_router_versions_api_v1_organisations__organisation_id__model_routers__router_id__versions_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "router_id", "required": true, "schema": { "title": "Router Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ModelRouterVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Organisation Model Router Versions", "tags": [ "model-routers" ] } }, "/api/v1/organisations/{organisation_id}/model-routers/{router_id}/versions/{version}": { "get": { "description": "Fetch one published version of a router; a draft's number is not there.", "operationId": "get_organisation_model_router_version_api_v1_organisations__organisation_id__model_routers__router_id__versions__version__get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "router_id", "required": true, "schema": { "title": "Router Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRouterVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Organisation Model Router Version", "tags": [ "model-routers" ] } }, "/api/v1/organisations/{organisation_id}/policy": { "delete": { "description": "Take the policy document of one organisation this key administers away: its keys are then\ndecided against their own documents alone, and it reaches no host, the hosts the document\npermitted going with it. `If-Match` holds it to the version a read answered.", "operationId": "delete_child_organisation_policy_api_v1_organisations__organisation_id__policy_delete", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "in": "header", "name": "If-Match", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "title": "If-Match" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Child Organisation Policy", "tags": [ "organisation" ] }, "get": { "description": "Show the policy document of one organisation this key administers, or `null` when it\nwrote none.\n\nThe same call `GET /tenants/{id}/policy` is, made by a key of an organisation above instead\nof by a person. Reading is outside the `keys` reservation, as listing the organisation's\nkeys is.", "operationId": "get_child_organisation_policy_api_v1_organisations__organisation_id__policy_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationPolicyRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Child Organisation Policy", "tags": [ "organisation" ] }, "put": { "description": "Replace the policy document of one organisation this key administers, whole.\n\n**Send a whole one**: a kind the document writes no rule over is refused to every key of\nthat organisation, so start from `GET /organisation/policy/default` and narrow that. A body\nthat omits `rules` stores the organisation's default rules. The document is held to that\norganisation's own label vocabulary, and a reservation of key management binds the\norganisation it was set on, never the one above that set it. `If-Match` carrying the\n`version` a read answered refuses the write `409` when the stored document changed after\nthat read.", "operationId": "put_child_organisation_policy_api_v1_organisations__organisation_id__policy_put", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "in": "header", "name": "If-Match", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "title": "If-Match" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationPolicyRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Put Child Organisation Policy", "tags": [ "organisation" ] } }, "/api/v1/organisations/{organisation_id}/policy/decisions": { "post": { "description": "Try a policy document for one organisation this key administers before `PUT`ting it, as\n`POST /organisation/policy/decisions` does for the key's own: `key_id` names a key of that\norganisation. The document is refused exactly as the `PUT` would refuse it; nothing is\nwritten.", "operationId": "try_child_organisation_policy_api_v1_organisations__organisation_id__policy_decisions_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyDocumentDecisionsAsk" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyDocumentDecisionsRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Try Child Organisation Policy", "tags": [ "organisation" ] } }, "/api/v1/organisations/{organisation_id}/policy/versions": { "get": { "description": "List the published versions of the policy document of one organisation this key\nadministers.", "operationId": "list_child_organisation_policy_versions_api_v1_organisations__organisation_id__policy_versions_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_OrganisationPolicyVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Child Organisation Policy Versions", "tags": [ "organisation" ] } }, "/api/v1/organisations/{organisation_id}/policy/versions/{version}": { "get": { "description": "Fetch one published version of the policy document of one organisation this key\nadministers.", "operationId": "get_child_organisation_policy_version_api_v1_organisations__organisation_id__policy_versions__version__get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationPolicyVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Child Organisation Policy Version", "tags": [ "organisation" ] } }, "/api/v1/organisations/{organisation_id}/publications": { "get": { "description": "List what one organisation this key administers publishes.", "operationId": "list_organisation_publications_api_v1_organisations__organisation_id__publications_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_PublicationRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Organisation Publications", "tags": [ "sharing" ] }, "post": { "description": "Create a publication offered by one organisation this key administers.", "operationId": "create_organisation_publication_api_v1_organisations__organisation_id__publications_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Organisation Publication", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/publications/{publication_id}": { "get": { "description": "Show one publication of one organisation this key administers.", "operationId": "get_organisation_publication_api_v1_organisations__organisation_id__publications__publication_id__get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Organisation Publication", "tags": [ "sharing" ] }, "patch": { "description": "Change this publication's description, the one field that is not fixed at creation.\n\nThe name and the visibility stay (`422` if named), a withdrawn publication is `409`, and on a\n**listed `catalogue`** publication the new words wait as `pending_description` until an\noperator next lists a version, because strangers read that text\n([Tenancy](tenancy.md#the-catalogue)). Everywhere else they apply at once.", "operationId": "update_organisation_publication_api_v1_organisations__organisation_id__publications__publication_id__patch", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Organisation Publication", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/publications/{publication_id}/cover": { "delete": { "description": "Remove the listing cover of one publication of one organisation this key administers.", "operationId": "delete_organisation_publication_cover_api_v1_organisations__organisation_id__publications__publication_id__cover_delete", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Organisation Publication Cover", "tags": [ "sharing" ] }, "get": { "description": "The listing cover of one publication of one organisation this key administers.", "operationId": "get_organisation_publication_cover_api_v1_organisations__organisation_id__publications__publication_id__cover_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } } }, "description": "The cover image." }, "304": { "description": "The caller's copy is current." }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Organisation Publication Cover", "tags": [ "sharing" ] }, "put": { "description": "Put the listing cover on one publication of one organisation this key administers.", "operationId": "set_organisation_publication_cover_api_v1_organisations__organisation_id__publications__publication_id__cover_put", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "The image itself, as the whole body: a PNG, a JPEG or a WebP. Send its own type as `Content-Type` -- what decides acceptance is the bytes, not the header.", "required": true }, "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "415": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem415", "type": "object" } } }, "description": "Unsupported Media Type" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Set Organisation Publication Cover", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/publications/{publication_id}/entitlements": { "get": { "description": "Who is entitled to one publication of one organisation this key administers.", "operationId": "list_organisation_publication_entitlements_api_v1_organisations__organisation_id__publications__publication_id__entitlements_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_EntitlementRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Organisation Publication Entitlements", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/publications/{publication_id}/files/{sha256}": { "get": { "description": "Whether an organisation's publication holds a file with this digest.", "operationId": "get_organisation_publication_file_api_v1_organisations__organisation_id__publications__publication_id__files__sha256__get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "description": "The file's SHA-256 hex digest", "in": "path", "name": "sha256", "required": true, "schema": { "description": "The file's SHA-256 hex digest", "pattern": "^[0-9a-f]{64}$", "title": "Sha256", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationFileRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Organisation Publication File", "tags": [ "sharing" ] }, "put": { "description": "Hold one file a script member will name, for an organisation's publication.", "operationId": "upload_organisation_publication_file_api_v1_organisations__organisation_id__publications__publication_id__files__sha256__put", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "description": "The file's SHA-256 hex digest", "in": "path", "name": "sha256", "required": true, "schema": { "description": "The file's SHA-256 hex digest", "pattern": "^[0-9a-f]{64}$", "title": "Sha256", "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "The file itself, as the whole body: one file of a script member, or a package only the publisher approved. At most scripts_publication_file_max_bytes, 32 MiB unless the deployment lowered it.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationFileRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Upload Organisation Publication File", "tags": [ "sharing" ], "x-body-limit": { "max_bytes": 33554432, "refusal": "A file is larger than this deployment holds for a publication." } } }, "/api/v1/organisations/{organisation_id}/publications/{publication_id}/submit": { "post": { "description": "Put this catalogue publication in front of an operator.", "operationId": "submit_organisation_publication_api_v1_organisations__organisation_id__publications__publication_id__submit_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Submit Organisation Publication", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/publications/{publication_id}/versions": { "get": { "description": "Every version one organisation this key administers has published of one publication.", "operationId": "list_organisation_publication_versions_api_v1_organisations__organisation_id__publications__publication_id__versions_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_PublicationVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Organisation Publication Versions", "tags": [ "sharing" ] }, "post": { "description": "Publish a new version of one publication of one organisation this key administers, from\nrows of that organisation's own plane or from a whole manifest.", "operationId": "create_organisation_publication_version_api_v1_organisations__organisation_id__publications__publication_id__versions_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationVersionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Organisation Publication Version", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/publications/{publication_id}/versions/test": { "post": { "description": "Check a version of one publication of one organisation this key administers without\npublishing it: the same body, the same refusals, nothing written.", "operationId": "check_organisation_publication_version_api_v1_organisations__organisation_id__publications__publication_id__versions_test_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationVersionCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationVersionCheck" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Check Organisation Publication Version", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/publications/{publication_id}/versions/{version}": { "get": { "description": "Show one published version of one publication of one organisation this key administers.", "operationId": "get_organisation_publication_version_api_v1_organisations__organisation_id__publications__publication_id__versions__version__get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Organisation Publication Version", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/publications/{publication_id}/versions/{version}/members/script/{member}/files/{path}": { "get": { "description": "One file of one script member of an organisation's published version.", "operationId": "get_organisation_publication_member_file_api_v1_organisations__organisation_id__publications__publication_id__versions__version__members_script__member__files__path__get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "in": "path", "name": "member", "required": true, "schema": { "title": "Member", "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "title": "Path", "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Organisation Publication Member File", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/publications/{publication_id}/versions/{version}/members/script/{member}/packages/{sha256}": { "get": { "description": "The file of one package a script member of an organisation's published version carries.", "operationId": "get_organisation_publication_member_package_api_v1_organisations__organisation_id__publications__publication_id__versions__version__members_script__member__packages__sha256__get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "in": "path", "name": "member", "required": true, "schema": { "title": "Member", "type": "string" } }, { "description": "The file's SHA-256 hex digest", "in": "path", "name": "sha256", "required": true, "schema": { "description": "The file's SHA-256 hex digest", "pattern": "^[0-9a-f]{64}$", "title": "Sha256", "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Organisation Publication Member Package", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/publications/{publication_id}/versions/{version}/members/{kind}/{member}/cover": { "delete": { "description": "Take the picture off one member of one published version. Idempotent.", "operationId": "delete_organisation_publication_member_cover_api_v1_organisations__organisation_id__publications__publication_id__versions__version__members__kind___member__cover_delete", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "in": "path", "name": "kind", "required": true, "schema": { "enum": [ "api_connector", "sql_connector", "script", "mcp_server", "toolset", "agent", "tool_alias" ], "title": "Kind", "type": "string" } }, { "in": "path", "name": "member", "required": true, "schema": { "title": "Member", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Organisation Publication Member Cover", "tags": [ "sharing" ] }, "get": { "description": "The picture one published version carries for one member.", "operationId": "get_organisation_publication_member_cover_api_v1_organisations__organisation_id__publications__publication_id__versions__version__members__kind___member__cover_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "in": "path", "name": "kind", "required": true, "schema": { "enum": [ "api_connector", "sql_connector", "script", "mcp_server", "toolset", "agent", "tool_alias" ], "title": "Kind", "type": "string" } }, { "in": "path", "name": "member", "required": true, "schema": { "title": "Member", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } } }, "description": "The cover image." }, "304": { "description": "The caller's copy is current." }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Organisation Publication Member Cover", "tags": [ "sharing" ] }, "put": { "description": "Put a picture on one member of one published version.", "operationId": "set_organisation_publication_member_cover_api_v1_organisations__organisation_id__publications__publication_id__versions__version__members__kind___member__cover_put", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "in": "path", "name": "kind", "required": true, "schema": { "enum": [ "api_connector", "sql_connector", "script", "mcp_server", "toolset", "agent", "tool_alias" ], "title": "Kind", "type": "string" } }, { "in": "path", "name": "member", "required": true, "schema": { "title": "Member", "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "The image itself, as the whole body: a PNG, a JPEG or a WebP. Send its own type as `Content-Type` -- what decides acceptance is the bytes, not the header.", "required": true }, "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "415": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem415", "type": "object" } } }, "description": "Unsupported Media Type" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Set Organisation Publication Member Cover", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/publications/{publication_id}/withdraw": { "post": { "description": "Stop this publication being installed, and release what it installed.", "operationId": "withdraw_organisation_publication_api_v1_organisations__organisation_id__publications__publication_id__withdraw_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Withdraw Organisation Publication", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/routing-configs": { "get": { "description": "List the routing configurations of one organisation this key administers.", "operationId": "list_organisation_routing_configs_api_v1_organisations__organisation_id__routing_configs_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_RoutingConfigRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Organisation Routing Configs", "tags": [ "routing-configs" ] }, "post": { "description": "Create a routing configuration for one organisation this key administers.", "operationId": "create_organisation_routing_config_api_v1_organisations__organisation_id__routing_configs_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingConfigCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingConfigRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Organisation Routing Config", "tags": [ "routing-configs" ] } }, "/api/v1/organisations/{organisation_id}/routing-configs/{config_id}": { "delete": { "description": "Delete one routing configuration of one organisation this key administers. Refused while\na key, an agent's latest version or the organisation still names it.", "operationId": "delete_organisation_routing_config_api_v1_organisations__organisation_id__routing_configs__config_id__delete", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "config_id", "required": true, "schema": { "title": "Config Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Organisation Routing Config", "tags": [ "routing-configs" ] }, "get": { "description": "Fetch one routing configuration of one organisation this key administers.", "operationId": "get_organisation_routing_config_api_v1_organisations__organisation_id__routing_configs__config_id__get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "config_id", "required": true, "schema": { "title": "Config Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingConfigRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Organisation Routing Config", "tags": [ "routing-configs" ] }, "patch": { "description": "Rename a routing configuration or replace its chains, of one organisation this key\nadministers.", "operationId": "update_organisation_routing_config_api_v1_organisations__organisation_id__routing_configs__config_id__patch", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "config_id", "required": true, "schema": { "title": "Config Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingConfigUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingConfigRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Organisation Routing Config", "tags": [ "routing-configs" ] } }, "/api/v1/organisations/{organisation_id}/routing-configs/{config_id}/versions": { "get": { "description": "List the published versions of a configuration of one organisation this key administers.", "operationId": "list_organisation_routing_config_versions_api_v1_organisations__organisation_id__routing_configs__config_id__versions_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "config_id", "required": true, "schema": { "title": "Config Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_RoutingConfigVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Organisation Routing Config Versions", "tags": [ "routing-configs" ] } }, "/api/v1/organisations/{organisation_id}/routing-configs/{config_id}/versions/{version}": { "get": { "description": "Fetch one published version of a configuration of one organisation this key administers.", "operationId": "get_organisation_routing_config_version_api_v1_organisations__organisation_id__routing_configs__config_id__versions__version__get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "config_id", "required": true, "schema": { "title": "Config Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingConfigVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Organisation Routing Config Version", "tags": [ "routing-configs" ] } }, "/api/v1/organisations/{organisation_id}/subscriptions": { "get": { "description": "List what one organisation this key administers has installed.", "operationId": "list_organisation_subscriptions_api_v1_organisations__organisation_id__subscriptions_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_SubscriptionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Organisation Subscriptions", "tags": [ "sharing" ] }, "post": { "description": "Install a publication into one organisation this key administers.", "operationId": "create_organisation_subscription_api_v1_organisations__organisation_id__subscriptions_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Organisation Subscription", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/subscriptions/preview": { "post": { "description": "What installing this publication into one organisation this key administers would mean,\nwriting nothing.", "operationId": "preview_organisation_subscription_api_v1_organisations__organisation_id__subscriptions_preview_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallReport" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Preview Organisation Subscription", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/subscriptions/{subscription_id}": { "delete": { "description": "Un-subscribe one organisation this key administers from one publication.", "operationId": "delete_organisation_subscription_api_v1_organisations__organisation_id__subscriptions__subscription_id__delete", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Organisation Subscription", "tags": [ "sharing" ] }, "get": { "description": "Show one subscription of one organisation this key administers.", "operationId": "get_organisation_subscription_api_v1_organisations__organisation_id__subscriptions__subscription_id__get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Organisation Subscription", "tags": [ "sharing" ] }, "patch": { "description": "Supply parameter values, or accept a new version's terms, for one subscription of one\norganisation this key administers.", "operationId": "update_organisation_subscription_api_v1_organisations__organisation_id__subscriptions__subscription_id__patch", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Organisation Subscription", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/subscriptions/{subscription_id}/members/{member}/fork": { "post": { "description": "Detach one member's copies of one subscription of one organisation this key administers,\nso that organisation owns them.", "operationId": "fork_organisation_subscription_member_api_v1_organisations__organisation_id__subscriptions__subscription_id__members__member__fork_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } }, { "in": "path", "name": "member", "required": true, "schema": { "title": "Member", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Fork Organisation Subscription Member", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/subscriptions/{subscription_id}/secrets": { "patch": { "description": "Supply or replace the credentials one subscription of one organisation this key\nadministers asks for.", "operationId": "replace_organisation_subscription_secrets_api_v1_organisations__organisation_id__subscriptions__subscription_id__secrets_patch", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionSecrets" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Replace Organisation Subscription Secrets", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/subscriptions/{subscription_id}/sync": { "post": { "description": "Ask for one subscription of one organisation this key administers to sync directly.", "operationId": "request_organisation_subscription_sync_api_v1_organisations__organisation_id__subscriptions__subscription_id__sync_post", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncQueued" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Request Organisation Subscription Sync", "tags": [ "sharing" ] } }, "/api/v1/organisations/{organisation_id}/usage": { "get": { "description": "List a descendant organisation's usage records, each with what it cost -- the\nkey-facing twin of `GET /tenants/{tenant_id}/usage` for a key holding `management`.", "operationId": "list_organisation_usage_api_v1_organisations__organisation_id__usage_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "narrow to one request id", "in": "query", "name": "request_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one request id", "title": "Request Id" } }, { "description": "narrow to one response id", "in": "query", "name": "response_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one response id", "title": "Response Id" } }, { "description": "narrow to one usage kind", "in": "query", "name": "kind", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one usage kind", "title": "Kind" } }, { "description": "narrow to one key id", "in": "query", "name": "key_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one key id", "title": "Key Id" } }, { "description": "narrow to the rows metered for one person, by the id the calling application named them with; exact match, never a prefix", "in": "query", "name": "subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to the rows metered for one person, by the id the calling application named them with; exact match, never a prefix", "title": "Subject" } }, { "description": "only usage recorded at or after this instant (inclusive)", "in": "query", "name": "from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only usage recorded at or after this instant (inclusive)", "title": "From" } }, { "description": "only usage recorded before this instant (exclusive)", "in": "query", "name": "to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only usage recorded before this instant (exclusive)", "title": "To" } }, { "description": "narrow to the rows the turns of one agent wrote, by its name; exact match, and a nested agent turn's rows name the nested agent", "in": "query", "name": "agent", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to the rows the turns of one agent wrote, by its name; exact match, and a nested agent turn's rows name the nested agent", "title": "Agent" } }, { "description": "narrow to the rows one helper's work wrote, by its name -- a caller's own helper as its turns named it, or `assist.` for one of Core's; exact match, never a prefix", "in": "query", "name": "helper", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to the rows one helper's work wrote, by its name -- a caller's own helper as its turns named it, or `assist.` for one of Core's; exact match, never a prefix", "title": "Helper" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "in": "query", "name": "order", "required": false, "schema": { "default": "asc", "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "enum": [ "asc", "desc" ], "title": "Order", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_UsageRecordRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Organisation Usage", "tags": [ "usage", "audit" ] } }, "/api/v1/organisations/{organisation_id}/usage/by-key": { "get": { "description": "A descendant organisation's usage totalled per key -- the key-facing twin of\n`GET /tenants/{tenant_id}/usage/by-key` for a key holding `management`, its own organisation\nincluded.", "operationId": "summarize_organisation_usage_by_key_api_v1_organisations__organisation_id__usage_by_key_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "only usage recorded at or after this instant (inclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "in": "query", "name": "from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only usage recorded at or after this instant (inclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "title": "From" } }, { "description": "only usage recorded before this instant (exclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "in": "query", "name": "to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only usage recorded before this instant (exclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "title": "To" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageByKey" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Summarize Organisation Usage By Key", "tags": [ "usage", "audit" ] } }, "/api/v1/organisations/{organisation_id}/usage/by-subject": { "get": { "description": "A descendant organisation's usage totalled per subject -- the key-facing twin of\n`GET /tenants/{tenant_id}/usage/by-subject` for a key holding `management`.", "operationId": "summarize_organisation_usage_by_subject_api_v1_organisations__organisation_id__usage_by_subject_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "narrow to one key id", "in": "query", "name": "key_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one key id", "title": "Key Id" } }, { "description": "only usage recorded at or after this instant (inclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "in": "query", "name": "from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only usage recorded at or after this instant (inclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "title": "From" } }, { "description": "only usage recorded before this instant (exclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "in": "query", "name": "to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only usage recorded before this instant (exclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "title": "To" } }, { "description": "at most this many subjects in items; the count in subjects is never cut", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "description": "at most this many subjects in items; the count in subjects is never cut", "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "true to split every subject's total, unattributed included, by usage kind in by_kind", "in": "query", "name": "by_kind", "required": false, "schema": { "default": false, "description": "true to split every subject's total, unattributed included, by usage kind in by_kind", "title": "By Kind", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageBySubject" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Summarize Organisation Usage By Subject", "tags": [ "usage", "audit" ] } }, "/api/v1/organisations/{organisation_id}/usage/caps": { "get": { "description": "A descendant organisation's monthly cap and every registered key's, each with what has\nbeen spent against it so far this calendar month -- the key-facing twin of\n`GET /tenants/{tenant_id}/usage/caps` for a key holding `management`\n(`app.audit.usage_router.read_tenant_usage_caps`).", "operationId": "read_organisation_usage_caps_api_v1_organisations__organisation_id__usage_caps_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageCaps" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Read Organisation Usage Caps", "tags": [ "usage", "audit" ] } }, "/api/v1/organisations/{organisation_id}/usage/summary": { "get": { "description": "A descendant organisation's usage totals, grouped by kind, model and tool name -- the\nkey-facing twin of `GET /tenants/{tenant_id}/usage/summary` for a key holding `management`,\non the same terms: `include_children` sums the whole subtree\n(`app.audit.subtree.summarize_subtree_usage`), and `interval=day` adds a daily `series`,\nrefused together with `include_children`\n(`app.audit.usage_router.summarize_tenant_usage`, `app.audit.usage_series.series_days`).\n\nOf one organisation strictly below the key's own, without a daily series, each total also\ncarries `paid_eur`: the same usage at the key's organisation's prices, what it pays for what\nthat organisation is charged (`docs/architecture/audit-and-metering.md#charged-beside-paid`).", "operationId": "summarize_organisation_usage_api_v1_organisations__organisation_id__usage_summary_get", "parameters": [ { "in": "path", "name": "organisation_id", "required": true, "schema": { "title": "Organisation Id", "type": "string" } }, { "description": "also count every organisation below this one that is not erased, each total naming the organisation it is for", "in": "query", "name": "include_children", "required": false, "schema": { "default": false, "description": "also count every organisation below this one that is not erased, each total naming the organisation it is for", "title": "Include Children", "type": "boolean" } }, { "description": "narrow to one key id", "in": "query", "name": "key_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one key id", "title": "Key Id" } }, { "description": "only usage recorded at or after this instant (inclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "in": "query", "name": "from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only usage recorded at or after this instant (inclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "title": "From" } }, { "description": "only usage recorded before this instant (exclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "in": "query", "name": "to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only usage recorded before this instant (exclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "title": "To" } }, { "description": "'day' adds a daily cost series to the response, one entry per UTC calendar day inside `from`/`to`, zero-filled where a day has no rows; `from` and `to` are required together with it and the window is capped at 366 UTC days", "in": "query", "name": "interval", "required": false, "schema": { "anyOf": [ { "const": "day", "type": "string" }, { "type": "null" } ], "description": "'day' adds a daily cost series to the response, one entry per UTC calendar day inside `from`/`to`, zero-filled where a day has no rows; `from` and `to` are required together with it and the window is capped at 366 UTC days", "title": "Interval" } }, { "description": "narrow to the rows one request metered -- every turn it ran, a nested agent turn's included, and every tool it invoked -- by the `X-Request-Id` its answer carried", "in": "query", "name": "request_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to the rows one request metered -- every turn it ran, a nested agent turn's included, and every tool it invoked -- by the `X-Request-Id` its answer carried", "title": "Request Id" } }, { "description": "narrow to the rows metered under one response id; a nested agent turn has an id of its own, so a whole request is `request_id`", "in": "query", "name": "response_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to the rows metered under one response id; a nested agent turn has an id of its own, so a whole request is `request_id`", "title": "Response Id" } }, { "description": "narrow to the rows the responses of one thread metered -- what the chat cost; a nested agent turn that ran outside the thread is not among them, its request is `request_id`. Read from the organisation's own rows, so a deleted thread no longer narrows, and a subject token reads its own person's rows inside the thread only", "in": "query", "name": "thread_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to the rows the responses of one thread metered -- what the chat cost; a nested agent turn that ran outside the thread is not among them, its request is `request_id`. Read from the organisation's own rows, so a deleted thread no longer narrows, and a subject token reads its own person's rows inside the thread only", "title": "Thread Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageSummary" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Summarize Organisation Usage", "tags": [ "usage", "audit" ] } }, "/api/v1/packages": { "get": { "description": "What this organisation's scripts may name: the deployment's list, then its own, each\nmarked by `approval`, one cursor over both.", "operationId": "list_packages_api_v1_packages_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_PackageRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Packages", "tags": [ "packages" ] }, "post": { "description": "Approve one package file for this organisation's own scripts; the body is the file.\n\nA PyPI package is a wheel whose tags load on the sandbox image; an npm package is the\ntarball `npm pack` writes. `409` when it is on the list already or the list holds 500.\n`403` while the organisation's parent has reserved key management to itself, as for its\nallowed hosts.", "operationId": "approve_package_api_v1_packages_post", "parameters": [ { "description": "`pypi` or `npm`", "in": "query", "name": "ecosystem", "required": true, "schema": { "description": "`pypi` or `npm`", "maxLength": 8, "title": "Ecosystem", "type": "string" } }, { "description": "The package's name", "in": "query", "name": "name", "required": true, "schema": { "description": "The package's name", "maxLength": 214, "title": "Name", "type": "string" } }, { "description": "The exact version", "in": "query", "name": "version", "required": true, "schema": { "description": "The exact version", "maxLength": 64, "title": "Version", "type": "string" } }, { "description": "The file's own name: a PEP 427 wheel name for `pypi`, a `.tgz` for `npm`", "in": "query", "name": "filename", "required": true, "schema": { "description": "The file's own name: a PEP 427 wheel name for `pypi`, a `.tgz` for `npm`", "maxLength": 255, "title": "Filename", "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "The package's file itself, as the whole body: a wheel for `pypi`, the tarball `npm pack` writes for `npm`. At most 32 MiB.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Approve Package", "tags": [ "packages" ], "x-body-limit": { "max_bytes": 33554432, "refusal": "A package file is at most 32 MiB." } } }, "/api/v1/packages/{package_id}": { "delete": { "description": "Revoke one of this organisation's own approvals, its file with it; `403` for one the\ndeployment approved, and under the same reservation as approving. A script version naming\nit is not rewritten; its next call is refused.", "operationId": "revoke_package_api_v1_packages__package_id__delete", "parameters": [ { "in": "path", "name": "package_id", "required": true, "schema": { "title": "Package Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Revoke Package", "tags": [ "packages" ] }, "get": { "description": "One package of either list this organisation's scripts may name.", "operationId": "get_package_api_v1_packages__package_id__get", "parameters": [ { "in": "path", "name": "package_id", "required": true, "schema": { "title": "Package Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Package", "tags": [ "packages" ] } }, "/api/v1/pages": { "get": { "description": "List the pages this key reaches: those whose current version is a file it could read.", "operationId": "list_all_pages_api_v1_pages_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_PageRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List All Pages", "tags": [ "pages" ] }, "post": { "description": "Publish a stored HTML file under a name: a page whose version 1 is that file, kept past\nthe retention window from now on. `409` for a file that is not HTML and a name taken.", "operationId": "create_page_api_v1_pages_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Page", "tags": [ "pages" ] } }, "/api/v1/pages/{page_id}": { "delete": { "description": "Delete a page: its name, versions and share links, which stop opening at once. Its files\nstay, kept, until they are deleted as files.", "operationId": "remove_page_api_v1_pages__page_id__delete", "parameters": [ { "in": "path", "name": "page_id", "required": true, "schema": { "title": "Page Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Remove Page", "tags": [ "pages" ] }, "get": { "description": "Fetch one page: its name, the version it shows now and that version's file.", "operationId": "read_page_api_v1_pages__page_id__get", "parameters": [ { "in": "path", "name": "page_id", "required": true, "schema": { "title": "Page Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Read Page", "tags": [ "pages" ] }, "patch": { "description": "Roll a page back or forward and/or rename it. `422` for a version it does not have, `409`\nfor a name taken, `403` for moving a page with a live link the caller could not make.", "operationId": "patch_page_api_v1_pages__page_id__patch", "parameters": [ { "in": "path", "name": "page_id", "required": true, "schema": { "title": "Page Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Patch Page", "tags": [ "pages" ] } }, "/api/v1/pages/{page_id}/links": { "get": { "description": "List the share links on a page, oldest first; an expired one stays listed.", "operationId": "list_links_on_page_api_v1_pages__page_id__links_get", "parameters": [ { "in": "path", "name": "page_id", "required": true, "schema": { "title": "Page Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ShareLinkRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Links On Page", "tags": [ "pages" ] }, "post": { "description": "Share a page through a link that opens it with no credential until it expires, at\nwhichever version is current. `403` unless policy allows share links, `422` for too long.", "operationId": "create_link_on_page_api_v1_pages__page_id__links_post", "parameters": [ { "in": "path", "name": "page_id", "required": true, "schema": { "title": "Page Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ShareLinkCreate" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareLinkRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Link On Page", "tags": [ "pages" ] } }, "/api/v1/pages/{page_id}/links/{link_id}": { "delete": { "description": "Revoke one share link on a page: its address stops opening the page at once.", "operationId": "revoke_link_on_page_api_v1_pages__page_id__links__link_id__delete", "parameters": [ { "in": "path", "name": "page_id", "required": true, "schema": { "title": "Page Id", "type": "string" } }, { "in": "path", "name": "link_id", "required": true, "schema": { "title": "Link Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Revoke Link On Page", "tags": [ "pages" ] }, "get": { "description": "Fetch one share link on a page.", "operationId": "get_link_on_page_api_v1_pages__page_id__links__link_id__get", "parameters": [ { "in": "path", "name": "page_id", "required": true, "schema": { "title": "Page Id", "type": "string" } }, { "in": "path", "name": "link_id", "required": true, "schema": { "title": "Link Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareLinkRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Link On Page", "tags": [ "pages" ] } }, "/api/v1/pages/{page_id}/versions": { "get": { "description": "List a page's published versions, oldest first, each with the file it shows.", "operationId": "list_versions_of_page_api_v1_pages__page_id__versions_get", "parameters": [ { "in": "path", "name": "page_id", "required": true, "schema": { "title": "Page Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_PageVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Versions Of Page", "tags": [ "pages" ] }, "post": { "description": "Publish a stored HTML file as the next version of a page, shown from now on at every\naddress the page has. `409` for a file that is not HTML, for another person or governed\notherwise than the page; `403` while the page has a live link the caller could not make.", "operationId": "create_page_version_api_v1_pages__page_id__versions_post", "parameters": [ { "in": "path", "name": "page_id", "required": true, "schema": { "title": "Page Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageVersionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Page Version", "tags": [ "pages" ] } }, "/api/v1/pages/{page_id}/view": { "post": { "description": "Mint a short-lived address that serves a page: whichever version is current when the\naddress is opened. A page of an artifact is gated on the key's data-egress policy.", "operationId": "view_a_page_api_v1_pages__page_id__view_post", "parameters": [ { "in": "path", "name": "page_id", "required": true, "schema": { "title": "Page Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewTicketRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "View A Page", "tags": [ "pages" ] } }, "/api/v1/prompts": { "get": { "description": "List the calling key's tenant's prompts, each with its latest version.", "operationId": "list_prompts_api_v1_prompts_get", "parameters": [ { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "name", "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_PromptRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Prompts", "tags": [ "prompts" ] }, "post": { "description": "Create a prompt and its first version, decided as a `write` for the person the request\nnames.", "operationId": "create_prompt_api_v1_prompts_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Prompt", "tags": [ "prompts" ] } }, "/api/v1/prompts/{prompt_id}": { "delete": { "description": "Delete a prompt and all its versions, decided for the person the request names; `409`\nwhile an agent version pins one of them.", "operationId": "delete_prompt_api_v1_prompts__prompt_id__delete", "parameters": [ { "in": "path", "name": "prompt_id", "required": true, "schema": { "title": "Prompt Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Prompt", "tags": [ "prompts" ] }, "get": { "description": "Fetch one prompt with its latest version.", "operationId": "get_prompt_api_v1_prompts__prompt_id__get", "parameters": [ { "in": "path", "name": "prompt_id", "required": true, "schema": { "title": "Prompt Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Prompt", "tags": [ "prompts" ] } }, "/api/v1/prompts/{prompt_id}/copy": { "post": { "description": "Create a new prompt from one published version of this one, decided as a read of this\nprompt and a create of the new one for the person the request names.", "operationId": "copy_prompt_api_v1_prompts__prompt_id__copy_post", "parameters": [ { "in": "path", "name": "prompt_id", "required": true, "schema": { "title": "Prompt Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptCopyCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Copy Prompt", "tags": [ "prompts" ] } }, "/api/v1/prompts/{prompt_id}/versions": { "get": { "description": "List a prompt's versions, oldest first, or newest first\nwith `order=desc`; cursor = version number.", "operationId": "list_versions_api_v1_prompts__prompt_id__versions_get", "parameters": [ { "in": "path", "name": "prompt_id", "required": true, "schema": { "title": "Prompt Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "in": "query", "name": "order", "required": false, "schema": { "default": "asc", "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "enum": [ "asc", "desc" ], "title": "Order", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_PromptVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Versions", "tags": [ "prompts" ] }, "post": { "description": "Add a new version to a prompt, decided as a `write` for the person the request names.", "operationId": "create_version_api_v1_prompts__prompt_id__versions_post", "parameters": [ { "in": "path", "name": "prompt_id", "required": true, "schema": { "title": "Prompt Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptVersionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Version", "tags": [ "prompts" ] } }, "/api/v1/prompts/{prompt_id}/versions/{version}": { "get": { "description": "Fetch one specific version of a prompt.", "operationId": "get_version_api_v1_prompts__prompt_id__versions__version__get", "parameters": [ { "in": "path", "name": "prompt_id", "required": true, "schema": { "title": "Prompt Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Version", "tags": [ "prompts" ] } }, "/api/v1/publications": { "get": { "description": "List what this key's own organisation publishes.", "operationId": "list_own_publications_api_v1_publications_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_PublicationRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Publications", "tags": [ "sharing" ] }, "post": { "description": "Create a publication offered by this key's own organisation.", "operationId": "create_own_publication_api_v1_publications_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Own Publication", "tags": [ "sharing" ] } }, "/api/v1/publications/{publication_id}": { "get": { "description": "Show one publication of this key's own organisation.", "operationId": "get_own_publication_api_v1_publications__publication_id__get", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Publication", "tags": [ "sharing" ] }, "patch": { "description": "Change this publication's description, the one field that is not fixed at creation.\n\nThe name and the visibility stay (`422` if named), a withdrawn publication is `409`, and on a\n**listed `catalogue`** publication the new words wait as `pending_description` until an\noperator next lists a version, because strangers read that text\n([Tenancy](tenancy.md#the-catalogue)). Everywhere else they apply at once.", "operationId": "update_own_publication_api_v1_publications__publication_id__patch", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Own Publication", "tags": [ "sharing" ] } }, "/api/v1/publications/{publication_id}/cover": { "delete": { "description": "Remove the listing cover of one publication of this key's own organisation. Idempotent.", "operationId": "delete_own_publication_cover_api_v1_publications__publication_id__cover_delete", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Own Publication Cover", "tags": [ "sharing" ] }, "get": { "description": "The listing cover of one publication of this key's own organisation, as bytes.", "operationId": "get_own_publication_cover_api_v1_publications__publication_id__cover_get", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } } }, "description": "The cover image." }, "304": { "description": "The caller's copy is current." }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Publication Cover", "tags": [ "sharing" ] }, "put": { "description": "Put the listing cover on one publication of this key's own organisation.", "operationId": "set_own_publication_cover_api_v1_publications__publication_id__cover_put", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "The image itself, as the whole body: a PNG, a JPEG or a WebP. Send its own type as `Content-Type` -- what decides acceptance is the bytes, not the header.", "required": true }, "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "415": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem415", "type": "object" } } }, "description": "Unsupported Media Type" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Set Own Publication Cover", "tags": [ "sharing" ] } }, "/api/v1/publications/{publication_id}/entitlements": { "get": { "description": "Who is entitled to one of this key's own organisation's publications.", "operationId": "list_own_publication_entitlements_api_v1_publications__publication_id__entitlements_get", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_EntitlementRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Publication Entitlements", "tags": [ "sharing" ] } }, "/api/v1/publications/{publication_id}/files/{sha256}": { "get": { "description": "Whether this key's own organisation's publication holds a file with this digest.", "operationId": "get_own_publication_file_api_v1_publications__publication_id__files__sha256__get", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "description": "The file's SHA-256 hex digest", "in": "path", "name": "sha256", "required": true, "schema": { "description": "The file's SHA-256 hex digest", "pattern": "^[0-9a-f]{64}$", "title": "Sha256", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationFileRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Publication File", "tags": [ "sharing" ] }, "put": { "description": "Hold one file a script member will name, for this key's own organisation's publication.", "operationId": "upload_own_publication_file_api_v1_publications__publication_id__files__sha256__put", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "description": "The file's SHA-256 hex digest", "in": "path", "name": "sha256", "required": true, "schema": { "description": "The file's SHA-256 hex digest", "pattern": "^[0-9a-f]{64}$", "title": "Sha256", "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "The file itself, as the whole body: one file of a script member, or a package only the publisher approved. At most scripts_publication_file_max_bytes, 32 MiB unless the deployment lowered it.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationFileRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Upload Own Publication File", "tags": [ "sharing" ], "x-body-limit": { "max_bytes": 33554432, "refusal": "A file is larger than this deployment holds for a publication." } } }, "/api/v1/publications/{publication_id}/submit": { "post": { "description": "Put this catalogue publication of this key's own organisation in front of an operator.", "operationId": "submit_own_publication_api_v1_publications__publication_id__submit_post", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Submit Own Publication", "tags": [ "sharing" ] } }, "/api/v1/publications/{publication_id}/versions": { "get": { "description": "Every version this key's own organisation has published of one of its publications.", "operationId": "list_own_publication_versions_api_v1_publications__publication_id__versions_get", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_PublicationVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Publication Versions", "tags": [ "sharing" ] }, "post": { "description": "Publish a new version of one of this key's own organisation's publications, from rows or\nfrom a whole manifest.", "operationId": "create_own_publication_version_api_v1_publications__publication_id__versions_post", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationVersionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Own Publication Version", "tags": [ "sharing" ] } }, "/api/v1/publications/{publication_id}/versions/test": { "post": { "description": "Check a version of one of this key's own organisation's publications without publishing\nit: the same body, the same refusals, nothing written.", "operationId": "check_own_publication_version_api_v1_publications__publication_id__versions_test_post", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationVersionCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationVersionCheck" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Check Own Publication Version", "tags": [ "sharing" ] } }, "/api/v1/publications/{publication_id}/versions/{version}": { "get": { "description": "Show one published version of this key's own organisation's publication.", "operationId": "get_own_publication_version_api_v1_publications__publication_id__versions__version__get", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Publication Version", "tags": [ "sharing" ] } }, "/api/v1/publications/{publication_id}/versions/{version}/members/script/{member}/files/{path}": { "get": { "description": "One file of one script member of this key's own organisation's published version.", "operationId": "get_own_publication_member_file_api_v1_publications__publication_id__versions__version__members_script__member__files__path__get", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "in": "path", "name": "member", "required": true, "schema": { "title": "Member", "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "title": "Path", "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Publication Member File", "tags": [ "sharing" ] } }, "/api/v1/publications/{publication_id}/versions/{version}/members/script/{member}/packages/{sha256}": { "get": { "description": "The file of one package a script member of this key's own organisation's published version\ncarries.", "operationId": "get_own_publication_member_package_api_v1_publications__publication_id__versions__version__members_script__member__packages__sha256__get", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "in": "path", "name": "member", "required": true, "schema": { "title": "Member", "type": "string" } }, { "description": "The file's SHA-256 hex digest", "in": "path", "name": "sha256", "required": true, "schema": { "description": "The file's SHA-256 hex digest", "pattern": "^[0-9a-f]{64}$", "title": "Sha256", "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Publication Member Package", "tags": [ "sharing" ] } }, "/api/v1/publications/{publication_id}/versions/{version}/members/{kind}/{member}/cover": { "delete": { "description": "Take the picture off one member of one published version. Idempotent.", "operationId": "delete_own_publication_member_cover_api_v1_publications__publication_id__versions__version__members__kind___member__cover_delete", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "in": "path", "name": "kind", "required": true, "schema": { "enum": [ "api_connector", "sql_connector", "script", "mcp_server", "toolset", "agent", "tool_alias" ], "title": "Kind", "type": "string" } }, { "in": "path", "name": "member", "required": true, "schema": { "title": "Member", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Own Publication Member Cover", "tags": [ "sharing" ] }, "get": { "description": "The picture one published version of this key's own organisation carries for one member.", "operationId": "get_own_publication_member_cover_api_v1_publications__publication_id__versions__version__members__kind___member__cover_get", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "in": "path", "name": "kind", "required": true, "schema": { "enum": [ "api_connector", "sql_connector", "script", "mcp_server", "toolset", "agent", "tool_alias" ], "title": "Kind", "type": "string" } }, { "in": "path", "name": "member", "required": true, "schema": { "title": "Member", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } } }, "description": "The cover image." }, "304": { "description": "The caller's copy is current." }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Publication Member Cover", "tags": [ "sharing" ] }, "put": { "description": "Put a picture on one member of one published version of this key's own organisation.", "operationId": "set_own_publication_member_cover_api_v1_publications__publication_id__versions__version__members__kind___member__cover_put", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "in": "path", "name": "kind", "required": true, "schema": { "enum": [ "api_connector", "sql_connector", "script", "mcp_server", "toolset", "agent", "tool_alias" ], "title": "Kind", "type": "string" } }, { "in": "path", "name": "member", "required": true, "schema": { "title": "Member", "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "The image itself, as the whole body: a PNG, a JPEG or a WebP. Send its own type as `Content-Type` -- what decides acceptance is the bytes, not the header.", "required": true }, "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "415": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem415", "type": "object" } } }, "description": "Unsupported Media Type" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Set Own Publication Member Cover", "tags": [ "sharing" ] } }, "/api/v1/publications/{publication_id}/withdraw": { "post": { "description": "Stop this publication being installed, and release what it installed.", "operationId": "withdraw_own_publication_api_v1_publications__publication_id__withdraw_post", "parameters": [ { "in": "path", "name": "publication_id", "required": true, "schema": { "title": "Publication Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Withdraw Own Publication", "tags": [ "sharing" ] } }, "/api/v1/responses": { "post": { "description": "Run one Responses-compatible turn through the governed tool loop.\n\n201 with `Location` when a new response was just stored to a thread; 200 for a stateless\nturn, or for an idempotency replay of a previously stored one.\n\n`stream: true` is always 200 and `text/event-stream`, a stored turn included: the status\nline goes out before the turn runs, so there is no 201 left to send and no `Location` to\nsend it with -- the id is in the first event instead\n(`docs/architecture/responses.md` \"Streaming\").", "operationId": "create_response_api_v1_responses_post", "parameters": [ { "in": "header", "name": "idempotency-key", "required": false, "schema": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateResponseRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseObject" } }, "text/event-stream": { "schema": { "description": "One event of a streamed response.", "oneOf": [ { "additionalProperties": false, "description": "The turn was accepted and has an id; nothing has run yet.", "properties": { "response": { "$ref": "#/components/schemas/ResponseObject", "description": "the response as it stands, before the turn ran" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.created", "default": "response.created", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "response" ], "title": "ResponseCreatedEvent", "type": "object" }, { "additionalProperties": false, "description": "The turn has started running.", "properties": { "response": { "$ref": "#/components/schemas/ResponseObject", "description": "the response as it stands, with no output yet" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.in_progress", "default": "response.in_progress", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "response" ], "title": "ResponseInProgressEvent", "type": "object" }, { "additionalProperties": false, "description": "An output item has started; its content follows, or is already complete.", "properties": { "item": { "description": "the item, empty of text when deltas follow", "discriminator": { "mapping": { "custom_tool_call": "#/components/schemas/CustomToolCallOutput", "function_call": "#/components/schemas/FunctionCallOutput", "mcp_approval_request": "#/components/schemas/McpApprovalRequestOutput", "mcp_call": "#/components/schemas/McpCallOutput", "message": "#/components/schemas/MessageOutput", "reasoning": "#/components/schemas/ReasoningOutput" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/MessageOutput" }, { "$ref": "#/components/schemas/ReasoningOutput" }, { "$ref": "#/components/schemas/FunctionCallOutput" }, { "$ref": "#/components/schemas/CustomToolCallOutput" }, { "$ref": "#/components/schemas/McpCallOutput" }, { "$ref": "#/components/schemas/McpApprovalRequestOutput" } ], "title": "Item" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.output_item.added", "default": "response.output_item.added", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "output_index", "item" ], "title": "ResponseOutputItemAddedEvent", "type": "object" }, { "additionalProperties": false, "description": "A content part of an output item has started.", "properties": { "content_index": { "description": "position of the content part within the item", "title": "Content Index", "type": "integer" }, "item_id": { "description": "id of the output item this event is about", "title": "Item Id", "type": "string" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "part": { "description": "the part, empty of text when deltas follow", "discriminator": { "mapping": { "input_file": "#/components/schemas/InputFileContent", "input_image": "#/components/schemas/InputImageContent", "input_text": "#/components/schemas/InputTextContent", "output_text": "#/components/schemas/OutputTextContent", "refusal": "#/components/schemas/RefusalContent" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/OutputTextContent" }, { "$ref": "#/components/schemas/InputTextContent" }, { "$ref": "#/components/schemas/RefusalContent" }, { "$ref": "#/components/schemas/InputImageContent" }, { "$ref": "#/components/schemas/InputFileContent" } ], "title": "Part" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.content_part.added", "default": "response.content_part.added", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "item_id", "output_index", "content_index", "part" ], "title": "ResponseContentPartAddedEvent", "type": "object" }, { "additionalProperties": false, "description": "A piece of an output item's text, as the model produced it.", "properties": { "content_index": { "description": "position of the content part within the item", "title": "Content Index", "type": "integer" }, "delta": { "description": "text to append to the part built so far", "title": "Delta", "type": "string" }, "item_id": { "description": "id of the output item this event is about", "title": "Item Id", "type": "string" }, "logprobs": { "default": [], "description": "always empty: Core returns no token log probabilities, and the vendor's client types require the field", "items": { "additionalProperties": true, "type": "object" }, "title": "Logprobs", "type": "array" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.output_text.delta", "default": "response.output_text.delta", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "item_id", "output_index", "content_index", "delta" ], "title": "ResponseOutputTextDeltaEvent", "type": "object" }, { "additionalProperties": false, "description": "One citation the finished text names, and where in it the marker naming it stands.\n\nSent after the last delta and before `output_text.done`, because that is when it is known: a\nmarker is resolved against the turn's tool results once the whole text exists, and its\noffsets are into that text (`docs/architecture/responses.md#citations`).", "properties": { "annotation": { "description": "the source cited, and the span citing it", "discriminator": { "mapping": { "file_citation": "#/components/schemas/FileCitation", "url_citation": "#/components/schemas/UrlCitation" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/UrlCitation" }, { "$ref": "#/components/schemas/FileCitation" } ], "title": "Annotation" }, "annotation_index": { "description": "position of this annotation among the part's own, counting from 0", "title": "Annotation Index", "type": "integer" }, "content_index": { "description": "position of the content part within the item", "title": "Content Index", "type": "integer" }, "item_id": { "description": "id of the output item this event is about", "title": "Item Id", "type": "string" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.output_text.annotation.added", "default": "response.output_text.annotation.added", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "item_id", "output_index", "content_index", "annotation_index", "annotation" ], "title": "ResponseOutputTextAnnotationAddedEvent", "type": "object" }, { "additionalProperties": false, "description": "An output item's text is complete; `text` is all of it, deltas included.", "properties": { "content_index": { "description": "position of the content part within the item", "title": "Content Index", "type": "integer" }, "item_id": { "description": "id of the output item this event is about", "title": "Item Id", "type": "string" }, "logprobs": { "default": [], "description": "always empty: Core returns no token log probabilities, and the vendor's client types require the field", "items": { "additionalProperties": true, "type": "object" }, "title": "Logprobs", "type": "array" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "text": { "description": "the item's whole text", "title": "Text", "type": "string" }, "type": { "const": "response.output_text.done", "default": "response.output_text.done", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "item_id", "output_index", "content_index", "text" ], "title": "ResponseOutputTextDoneEvent", "type": "object" }, { "additionalProperties": false, "description": "A content part is complete; `part` carries all of its text.", "properties": { "content_index": { "description": "position of the content part within the item", "title": "Content Index", "type": "integer" }, "item_id": { "description": "id of the output item this event is about", "title": "Item Id", "type": "string" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "part": { "description": "the finished part", "discriminator": { "mapping": { "input_file": "#/components/schemas/InputFileContent", "input_image": "#/components/schemas/InputImageContent", "input_text": "#/components/schemas/InputTextContent", "output_text": "#/components/schemas/OutputTextContent", "refusal": "#/components/schemas/RefusalContent" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/OutputTextContent" }, { "$ref": "#/components/schemas/InputTextContent" }, { "$ref": "#/components/schemas/RefusalContent" }, { "$ref": "#/components/schemas/InputImageContent" }, { "$ref": "#/components/schemas/InputFileContent" } ], "title": "Part" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.content_part.done", "default": "response.content_part.done", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "item_id", "output_index", "content_index", "part" ], "title": "ResponseContentPartDoneEvent", "type": "object" }, { "additionalProperties": false, "description": "A call on a tool the caller runs: its arguments, whole.\n\nThere is no `response.function_call_arguments.delta` beside it. A provider hands Core a tool\ncall as one object -- name and arguments together -- so there was never a partial arguments\nstring to send, and inventing one would be a shape a reader could not trust.", "properties": { "arguments": { "description": "the call's arguments, as emitted (JSON text)", "title": "Arguments", "type": "string" }, "item_id": { "description": "id of the output item this event is about", "title": "Item Id", "type": "string" }, "name": { "description": "the name of the function that was called", "title": "Name", "type": "string" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.function_call_arguments.done", "default": "response.function_call_arguments.done", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "item_id", "output_index", "name", "arguments" ], "title": "ResponseFunctionCallArgumentsDoneEvent", "type": "object" }, { "additionalProperties": false, "description": "A call on a custom tool the caller runs: its free-text input, in one piece.\n\nOne delta, carrying the whole input, for the reason `response.function_call_arguments.done`\nhas none: a provider hands Core a call as one object, so the input arrives whole. The vendor's\nreaders accumulate the deltas of a custom call, so the one piece is sent rather than none.", "properties": { "delta": { "description": "the call's input; the whole of it", "title": "Delta", "type": "string" }, "item_id": { "description": "id of the output item this event is about", "title": "Item Id", "type": "string" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.custom_tool_call_input.delta", "default": "response.custom_tool_call_input.delta", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "item_id", "output_index", "delta" ], "title": "ResponseCustomToolCallInputDeltaEvent", "type": "object" }, { "additionalProperties": false, "description": "A call on a custom tool the caller runs: its free-text input, whole.", "properties": { "input": { "description": "the call's free-text input, as the model wrote it", "title": "Input", "type": "string" }, "item_id": { "description": "id of the output item this event is about", "title": "Item Id", "type": "string" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.custom_tool_call_input.done", "default": "response.custom_tool_call_input.done", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "item_id", "output_index", "input" ], "title": "ResponseCustomToolCallInputDoneEvent", "type": "object" }, { "additionalProperties": false, "description": "A call Core is about to run itself: its arguments, whole, for the same reason.", "properties": { "arguments": { "description": "the call's arguments, as emitted (JSON text)", "title": "Arguments", "type": "string" }, "item_id": { "description": "id of the output item this event is about", "title": "Item Id", "type": "string" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.mcp_call_arguments.done", "default": "response.mcp_call_arguments.done", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "item_id", "output_index", "arguments" ], "title": "ResponseMcpCallArgumentsDoneEvent", "type": "object" }, { "additionalProperties": false, "description": "Core has started running the tool this call names.", "properties": { "item_id": { "description": "id of the output item this event is about", "title": "Item Id", "type": "string" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.mcp_call.in_progress", "default": "response.mcp_call.in_progress", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "item_id", "output_index" ], "title": "ResponseMcpCallInProgressEvent", "type": "object" }, { "additionalProperties": false, "description": "The tool answered; the item's `output` follows on `output_item.done`.", "properties": { "item_id": { "description": "id of the output item this event is about", "title": "Item Id", "type": "string" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.mcp_call.completed", "default": "response.mcp_call.completed", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "item_id", "output_index" ], "title": "ResponseMcpCallCompletedEvent", "type": "object" }, { "additionalProperties": false, "description": "The call produced no output; the item's `error` follows on `output_item.done`.", "properties": { "item_id": { "description": "id of the output item this event is about", "title": "Item Id", "type": "string" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.mcp_call.failed", "default": "response.mcp_call.failed", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "item_id", "output_index" ], "title": "ResponseMcpCallFailedEvent", "type": "object" }, { "additionalProperties": false, "description": "One paragraph of a reasoning summary has started.", "properties": { "item_id": { "description": "id of the output item this event is about", "title": "Item Id", "type": "string" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "part": { "$ref": "#/components/schemas/SummaryText", "description": "the part, empty of text until it is done" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "summary_index": { "description": "position of the paragraph within the item's summary", "title": "Summary Index", "type": "integer" }, "type": { "const": "response.reasoning_summary_part.added", "default": "response.reasoning_summary_part.added", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "item_id", "output_index", "summary_index", "part" ], "title": "ResponseReasoningSummaryPartAddedEvent", "type": "object" }, { "additionalProperties": false, "description": "A piece of a reasoning summary's text, as the model produced it.", "properties": { "delta": { "description": "the text to append to the summary so far", "title": "Delta", "type": "string" }, "item_id": { "description": "id of the output item this event is about", "title": "Item Id", "type": "string" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "summary_index": { "description": "position of the paragraph within the item's summary", "title": "Summary Index", "type": "integer" }, "type": { "const": "response.reasoning_summary_text.delta", "default": "response.reasoning_summary_text.delta", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "item_id", "output_index", "summary_index", "delta" ], "title": "ResponseReasoningSummaryTextDeltaEvent", "type": "object" }, { "additionalProperties": false, "description": "That paragraph's text, whole -- after its deltas when the model streamed it, alone when\nthe summary arrived with the round it belongs to.", "properties": { "item_id": { "description": "id of the output item this event is about", "title": "Item Id", "type": "string" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "summary_index": { "description": "position of the paragraph within the item's summary", "title": "Summary Index", "type": "integer" }, "text": { "description": "the paragraph's whole text", "title": "Text", "type": "string" }, "type": { "const": "response.reasoning_summary_text.done", "default": "response.reasoning_summary_text.done", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "item_id", "output_index", "summary_index", "text" ], "title": "ResponseReasoningSummaryTextDoneEvent", "type": "object" }, { "additionalProperties": false, "description": "That paragraph is complete.", "properties": { "item_id": { "description": "id of the output item this event is about", "title": "Item Id", "type": "string" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "part": { "$ref": "#/components/schemas/SummaryText", "description": "the finished part" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "summary_index": { "description": "position of the paragraph within the item's summary", "title": "Summary Index", "type": "integer" }, "type": { "const": "response.reasoning_summary_part.done", "default": "response.reasoning_summary_part.done", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "item_id", "output_index", "summary_index", "part" ], "title": "ResponseReasoningSummaryPartDoneEvent", "type": "object" }, { "additionalProperties": false, "description": "An output item is complete, exactly as the finished response will carry it.", "properties": { "item": { "description": "the finished item", "discriminator": { "mapping": { "custom_tool_call": "#/components/schemas/CustomToolCallOutput", "function_call": "#/components/schemas/FunctionCallOutput", "mcp_approval_request": "#/components/schemas/McpApprovalRequestOutput", "mcp_call": "#/components/schemas/McpCallOutput", "message": "#/components/schemas/MessageOutput", "reasoning": "#/components/schemas/ReasoningOutput" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/MessageOutput" }, { "$ref": "#/components/schemas/ReasoningOutput" }, { "$ref": "#/components/schemas/FunctionCallOutput" }, { "$ref": "#/components/schemas/CustomToolCallOutput" }, { "$ref": "#/components/schemas/McpCallOutput" }, { "$ref": "#/components/schemas/McpApprovalRequestOutput" } ], "title": "Item" }, "output_index": { "description": "position of the item in the response's output list", "title": "Output Index", "type": "integer" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.output_item.done", "default": "response.output_item.done", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "output_index", "item" ], "title": "ResponseOutputItemDoneEvent", "type": "object" }, { "additionalProperties": false, "description": "The turn ran to the end; `response` is the whole response object.", "properties": { "response": { "$ref": "#/components/schemas/ResponseObject", "description": "the finished response" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.completed", "default": "response.completed", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "response" ], "title": "ResponseCompletedEvent", "type": "object" }, { "additionalProperties": false, "description": "The turn used up its tool rounds; `response` is the whole response object.", "properties": { "response": { "$ref": "#/components/schemas/ResponseObject", "description": "the incomplete response" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.incomplete", "default": "response.incomplete", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "response" ], "title": "ResponseIncompleteEvent", "type": "object" }, { "additionalProperties": false, "description": "The model call failed; `response` carries the fixed `error` the turn ended with.", "properties": { "response": { "$ref": "#/components/schemas/ResponseObject", "description": "the failed response" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "response.failed", "default": "response.failed", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "response" ], "title": "ResponseFailedEvent", "type": "object" }, { "additionalProperties": false, "description": "The stream itself broke after bytes had gone out, so no HTTP status could say so. Its\nwording is fixed: never a provider's text, never an exception's own message.", "properties": { "code": { "description": "a stable machine-readable error code", "title": "Code", "type": "string" }, "message": { "description": "a safe, fixed-wording description of the failure", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the failure is about, when it is about one", "title": "Param" }, "sequence_number": { "description": "position of this event in the stream, counting from 0", "title": "Sequence Number", "type": "integer" }, "type": { "const": "error", "default": "error", "description": "the event's type", "title": "Type", "type": "string" } }, "required": [ "sequence_number", "code", "message" ], "title": "ResponseStreamErrorEvent", "type": "object" } ], "title": "ResponseStreamEvent" } } }, "description": "Successful Response" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseObject" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody400", "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody429", "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem500", "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Response", "tags": [ "responses" ] } }, "/api/v1/responses/{response_id}": { "get": { "description": "Fetch a stored response and its output items.", "operationId": "get_response_api_v1_responses__response_id__get", "parameters": [ { "in": "path", "name": "response_id", "required": true, "schema": { "title": "Response Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseObject" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody400", "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "500": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem500", "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Response", "tags": [ "responses" ] } }, "/api/v1/responses/{response_id}/approvals/{approval_id}": { "post": { "description": "Approve or reject a tool call a background run parked for approval: 404 for a request the\nrun has none under, 409 unless the run waits and the request is still open, so the first\ndecision wins. A rejection is the call's result, with the reason; the decision that leaves\nno request open queues the run (`docs/architecture/runs.md#approval-before-a-tool-runs`).", "operationId": "decide_approval_api_v1_responses__response_id__approvals__approval_id__post", "parameters": [ { "in": "path", "name": "response_id", "required": true, "schema": { "title": "Response Id", "type": "string" } }, { "in": "path", "name": "approval_id", "required": true, "schema": { "title": "Approval Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalDecision" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseObject" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody400", "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "500": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem500", "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Decide Approval", "tags": [ "responses" ] } }, "/api/v1/responses/{response_id}/cancel": { "post": { "description": "Cancel a background run or a streamed turn still running.\n\nBehind no capability of its own, like `POST /responses`: the key that started a streamed turn\nmay stop it. Any other response -- a background run, another key's turn -- needs `runs`, and\nanswers 404 without it.\n\nA background run is `cancelled` at once and its executor stops once it notices. A streamed\nturn is stopped wherever it runs, and this answers the response it recorded -- `cancelled`,\nwith the output it had produced -- or 503 when it has not recorded itself in time; asking\nagain is safe. 409 for a response that already finished; the response itself for one already\ncancelled.", "operationId": "cancel_response_api_v1_responses__response_id__cancel_post", "parameters": [ { "in": "path", "name": "response_id", "required": true, "schema": { "title": "Response Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseObject" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody400", "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "500": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem500", "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Cancel Response", "tags": [ "responses" ] } }, "/api/v1/responses/{response_id}/checks": { "get": { "description": "Every live check result of a stored response, in the order decided: name, stage, kind,\nmode, attempt, outcome and a fixed reason. Never the text a check read.", "operationId": "get_response_checks_api_v1_responses__response_id__checks_get", "parameters": [ { "in": "path", "name": "response_id", "required": true, "schema": { "title": "Response Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ResponseCheckRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Response Checks", "tags": [ "responses" ] } }, "/api/v1/responses/{response_id}/routing": { "get": { "description": "How a stored response that named a router was routed: the classification, the rule that\ndecided, the list the model came from and every pool member with why it was kept or dropped.\nNo text: labels, numbers and model ids.", "operationId": "get_response_routing_api_v1_responses__response_id__routing_get", "parameters": [ { "in": "path", "name": "response_id", "required": true, "schema": { "title": "Response Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingDecisionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Response Routing", "tags": [ "model-routers" ] } }, "/api/v1/responses/{response_id}/tool_outputs": { "post": { "description": "Resume a suspended run with its pending client tool calls' results: 409 unless the\nresponse is `requires_action`; 422 unless the outputs cover exactly the pending call ids.", "operationId": "submit_tool_outputs_api_v1_responses__response_id__tool_outputs_post", "parameters": [ { "in": "path", "name": "response_id", "required": true, "schema": { "title": "Response Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitToolOutputsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseObject" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody400", "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody429", "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem500", "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The body every non-2xx answer on the Responses routes carries.", "properties": { "error": { "additionalProperties": false, "description": "The error object inside the vendor's envelope.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "a stable machine-readable code for this refusal", "title": "Code" }, "message": { "description": "a safe, fixed-wording description of what was refused", "title": "Message", "type": "string" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the request field the refusal is about, when it is about one", "title": "Param" }, "type": { "description": "the vendor's error class: `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `rate_limit_error` or `server_error`", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "VendorError", "type": "object" } }, "required": [ "error" ], "title": "VendorErrorBody503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Submit Tool Outputs", "tags": [ "responses" ] } }, "/api/v1/responses/{response_id}/trace": { "get": { "description": "Every model call one turn made, oldest first -- a fallover's retry as its own entry.\n\n`?limit=&cursor=` answering `{items, next_cursor}`, like every other list in this API: a turn\nthat walked a routing chain and ran a dozen tool rounds has more calls than one page should\never promise to hold (`docs/engineering/standard.md` §6).\n\nIdentifiers, timings, status and usage only: no document is read, so listing a turn's calls\ncosts no blob and writes no audit row. Opening one does both.", "operationId": "list_response_trace_api_v1_responses__response_id__trace_get", "parameters": [ { "in": "path", "name": "response_id", "required": true, "schema": { "title": "Response Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ModelCallRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Response Trace", "tags": [ "tracing" ] } }, "/api/v1/routing-configs": { "get": { "description": "List the routing configurations of the organisation this key belongs to.", "operationId": "list_own_routing_configs_api_v1_routing_configs_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_RoutingConfigRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Routing Configs", "tags": [ "routing-configs" ] }, "post": { "description": "Create a routing configuration for the organisation this key belongs to.", "operationId": "create_own_routing_config_api_v1_routing_configs_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingConfigCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingConfigRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Own Routing Config", "tags": [ "routing-configs" ] } }, "/api/v1/routing-configs/{config_id}": { "delete": { "description": "Delete one routing configuration of the organisation this key belongs to. Refused while a\nkey, an agent's latest version or the organisation still names it.", "operationId": "delete_own_routing_config_api_v1_routing_configs__config_id__delete", "parameters": [ { "in": "path", "name": "config_id", "required": true, "schema": { "title": "Config Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Own Routing Config", "tags": [ "routing-configs" ] }, "get": { "description": "Fetch one routing configuration of the organisation this key belongs to.", "operationId": "get_own_routing_config_api_v1_routing_configs__config_id__get", "parameters": [ { "in": "path", "name": "config_id", "required": true, "schema": { "title": "Config Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingConfigRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Routing Config", "tags": [ "routing-configs" ] }, "patch": { "description": "Rename a routing configuration or replace its chains, of the organisation this key\nbelongs to.", "operationId": "update_own_routing_config_api_v1_routing_configs__config_id__patch", "parameters": [ { "in": "path", "name": "config_id", "required": true, "schema": { "title": "Config Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingConfigUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingConfigRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Own Routing Config", "tags": [ "routing-configs" ] } }, "/api/v1/routing-configs/{config_id}/versions": { "get": { "description": "List the published versions of a configuration of this key's organisation.", "operationId": "list_own_routing_config_versions_api_v1_routing_configs__config_id__versions_get", "parameters": [ { "in": "path", "name": "config_id", "required": true, "schema": { "title": "Config Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_RoutingConfigVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Routing Config Versions", "tags": [ "routing-configs" ] } }, "/api/v1/routing-configs/{config_id}/versions/{version}": { "get": { "description": "Fetch one published version of a configuration of this key's organisation.", "operationId": "get_own_routing_config_version_api_v1_routing_configs__config_id__versions__version__get", "parameters": [ { "in": "path", "name": "config_id", "required": true, "schema": { "title": "Config Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingConfigVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Routing Config Version", "tags": [ "routing-configs" ] } }, "/api/v1/schedules": { "get": { "description": "List this tenant's schedules, newest first.", "operationId": "list_schedules_api_v1_schedules_get", "parameters": [ { "description": "only schedules that are enabled, or only those that are not", "in": "query", "name": "enabled", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "only schedules that are enabled, or only those that are not", "title": "Enabled" } }, { "description": "only schedules carrying this `name:value` label; repeat the parameter to require several, which are read as *and*", "in": "query", "name": "label", "required": false, "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "only schedules carrying this `name:value` label; repeat the parameter to require several, which are read as *and*", "title": "Label" } }, { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (desc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (desc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "name", "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ScheduleObject_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Schedules", "tags": [ "schedules" ] }, "post": { "description": "Create a schedule that fires as this key.\n\nA schedule the person in `X-Core-Subject` writes for herself keeps the\nattributes she asserts sealed, and every fire applies them until `subject_attributes_until`.", "operationId": "create_schedule_api_v1_schedules_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleObject" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Schedule", "tags": [ "schedules" ] } }, "/api/v1/schedules/preview": { "post": { "description": "What a cron expression means: the next few times it fires, in the zone it is read in.\n\nPure -- it reads no row and writes none -- so an author or an agent can check an expression\nbefore storing it. Declared above `/schedules/{schedule_id}`, because a path parameter would\notherwise swallow the word.", "operationId": "preview_schedule_api_v1_schedules_preview_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchedulePreviewRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchedulePreview" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Preview Schedule", "tags": [ "schedules" ] } }, "/api/v1/schedules/{schedule_id}": { "delete": { "description": "Delete a schedule. The turns it fired stay, and keep saying what fired them.", "operationId": "delete_schedule_api_v1_schedules__schedule_id__delete", "parameters": [ { "in": "path", "name": "schedule_id", "required": true, "schema": { "title": "Schedule Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Schedule", "tags": [ "schedules" ] }, "get": { "description": "Fetch one schedule, with the next few times it will fire.", "operationId": "get_schedule_api_v1_schedules__schedule_id__get", "parameters": [ { "in": "path", "name": "schedule_id", "required": true, "schema": { "title": "Schedule Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleObject" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Schedule", "tags": [ "schedules" ] }, "patch": { "description": "Change a schedule; an absent field keeps what is stored, and the next run is recomputed.\n\nThe schedule's own person writing it refreshes the attributes its fires apply; a new\n`subject_id`, or null, clears them.", "operationId": "update_schedule_api_v1_schedules__schedule_id__patch", "parameters": [ { "in": "path", "name": "schedule_id", "required": true, "schema": { "title": "Schedule Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleObject" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Schedule", "tags": [ "schedules" ] } }, "/api/v1/schedules/{schedule_id}/responses": { "get": { "description": "List the turns this schedule fired, newest first.\n\nEmpty for a schedule of kind `evaluation`: its fires queue evaluation runs rather than\nturns, and those are read from the suite's own list narrowed to this schedule,\n`GET /evaluations/{id}/runs?schedule_id=` (`docs/architecture/schedules.md`).", "operationId": "list_schedule_responses_api_v1_schedules__schedule_id__responses_get", "parameters": [ { "in": "path", "name": "schedule_id", "required": true, "schema": { "title": "Schedule Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ScheduleResponseSummary_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Schedule Responses", "tags": [ "schedules" ] } }, "/api/v1/schedules/{schedule_id}/run": { "post": { "description": "Fire this schedule now, as the key it names, without moving the time it runs at.\n\n`202`: the work is queued exactly as the worker's own tick queues it, and nothing has run\nyet. `409` while what the last fire queued is still going -- the same skip the tick makes,\nanswered rather than recorded, because a person pressing the button is owed the reason\n(`docs/architecture/schedules.md`).\n\nOne body per kind, because the two fires queue different things: a schedule of kind\n`response` is read back as itself, its clock and its last outcome included, and one of kind\n`evaluation` answers the ids of the runs it just queued, which is the one thing a caller\ncould not look up afterwards.", "operationId": "run_schedule_now_api_v1_schedules__schedule_id__run_post", "parameters": [ { "in": "path", "name": "schedule_id", "required": true, "schema": { "title": "Schedule Id", "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ScheduleObject" }, { "$ref": "#/components/schemas/ScheduleEvaluationFire" } ], "title": "Response Run Schedule Now Api V1 Schedules Schedule Id Run Post" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Run Schedule Now", "tags": [ "schedules" ] } }, "/api/v1/scripts": { "get": { "description": "List the organisation's scripts by id, each with its latest version.", "operationId": "list_scripts_api_v1_scripts_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ScriptRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Scripts", "tags": [ "scripts" ] }, "post": { "description": "Register a script and its version 1. `409` when the name is taken.", "operationId": "create_script_api_v1_scripts_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScriptCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScriptRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Script", "tags": [ "scripts" ] } }, "/api/v1/scripts/{script_id}": { "delete": { "description": "Delete a script, its versions and their files. `409` naming the agents that name it.", "operationId": "delete_script_api_v1_scripts__script_id__delete", "parameters": [ { "in": "path", "name": "script_id", "required": true, "schema": { "title": "Script Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Script", "tags": [ "scripts" ] }, "get": { "description": "Fetch one script with its latest version.", "operationId": "get_script_api_v1_scripts__script_id__get", "parameters": [ { "in": "path", "name": "script_id", "required": true, "schema": { "title": "Script Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScriptRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Script", "tags": [ "scripts" ] } }, "/api/v1/scripts/{script_id}/versions": { "get": { "description": "List one script's versions, newest first; the cursor is a version number.", "operationId": "list_script_versions_api_v1_scripts__script_id__versions_get", "parameters": [ { "in": "path", "name": "script_id", "required": true, "schema": { "title": "Script Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ScriptVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Script Versions", "tags": [ "scripts" ] }, "post": { "description": "Add the next version, holding the whole package. A package identical to the latest\nwrites none and answers the latest with `200`; `409` on a copy its publication writes.", "operationId": "create_script_version_api_v1_scripts__script_id__versions_post", "parameters": [ { "in": "path", "name": "script_id", "required": true, "schema": { "title": "Script Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScriptVersionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScriptVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Script Version", "tags": [ "scripts" ] } }, "/api/v1/scripts/{script_id}/versions/{version}": { "get": { "description": "Fetch one version of a script.", "operationId": "get_script_version_api_v1_scripts__script_id__versions__version__get", "parameters": [ { "in": "path", "name": "script_id", "required": true, "schema": { "title": "Script Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScriptVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Script Version", "tags": [ "scripts" ] } }, "/api/v1/scripts/{script_id}/versions/{version}/files/{path}": { "get": { "description": "One file of a version, its bytes with `ETag: \"\"`.", "operationId": "get_script_file_api_v1_scripts__script_id__versions__version__files__path__get", "parameters": [ { "in": "path", "name": "script_id", "required": true, "schema": { "title": "Script Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "in": "path", "name": "path", "required": true, "schema": { "title": "Path", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Script File", "tags": [ "scripts" ] } }, "/api/v1/service-accounts": { "get": { "description": "List this organisation's service accounts.", "operationId": "list_service_accounts_api_v1_service_accounts_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ServiceAccountRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Service Accounts", "tags": [ "service-accounts" ] }, "post": { "description": "Create a service account of this organisation and the one key it owns. The key's secret\nis in this response and nowhere else.", "operationId": "create_service_account_api_v1_service_accounts_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountIssued" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Service Account", "tags": [ "service-accounts" ] } }, "/api/v1/service-accounts/{account_id}": { "delete": { "description": "Delete the account as an erasure removes a person: its key goes at once, it is\n`deleting`, and its row leaves when the erasure of `sa:` has taken everything it holds.\n`409` under a legal hold.", "operationId": "delete_service_account_api_v1_service_accounts__account_id__delete", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Service Account", "tags": [ "service-accounts" ] }, "get": { "description": "Fetch one service account of this organisation.", "operationId": "get_service_account_api_v1_service_accounts__account_id__get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Service Account", "tags": [ "service-accounts" ] }, "patch": { "description": "Change a service account's agent, description, attributes or instruct list; its name is\nfixed.", "operationId": "update_service_account_api_v1_service_accounts__account_id__patch", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Service Account", "tags": [ "service-accounts" ] } }, "/api/v1/service-accounts/{account_id}/pause": { "post": { "description": "Pause the account and its key at once: its key is refused, its fires and pickups fail\n`service_account_paused`, and nobody may hand it work, until it is resumed.", "operationId": "pause_service_account_api_v1_service_accounts__account_id__pause_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Pause Service Account", "tags": [ "service-accounts" ] } }, "/api/v1/service-accounts/{account_id}/responses": { "get": { "description": "List the responses this service account ran, newest first: instructed work, its\nschedules' fires and its own key's turns. Never their output items. Writes nothing.", "operationId": "list_service_account_runs_api_v1_service_accounts__account_id__responses_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "only runs in one of these statuses; repeat it to name several, none for every status", "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "items": { "enum": [ "queued", "in_progress", "requires_action", "completed", "failed", "cancelled", "incomplete" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "only runs in one of these statuses; repeat it to name several, none for every status", "title": "Status" } }, { "description": "only runs this schedule's fires produced", "in": "query", "name": "schedule_id", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "only runs this schedule's fires produced", "title": "Schedule Id" } }, { "description": "only runs created at or after this instant (inclusive); none for no lower bound", "in": "query", "name": "from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only runs created at or after this instant (inclusive); none for no lower bound", "title": "From" } }, { "description": "only runs created before this instant (exclusive); none for no upper bound", "in": "query", "name": "to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only runs created before this instant (exclusive); none for no upper bound", "title": "To" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ServiceAccountRun_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Service Account Runs", "tags": [ "service-accounts" ] }, "post": { "description": "Hand the account a turn: queued in the background under the account's key, for\n`sa:`, naming this key and the person the request names as its instructor. Only\nmanagement and the keys on the account's instruct list may.", "operationId": "instruct_service_account_api_v1_service_accounts__account_id__responses_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "idempotency-key", "required": false, "schema": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateResponseRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseObject" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Instruct Service Account", "tags": [ "service-accounts" ] } }, "/api/v1/service-accounts/{account_id}/responses/{response_id}": { "get": { "description": "Read a turn handed to the account: management, the account's own key, and the key that\nhanded it over, for the person it named, may.", "operationId": "get_service_account_response_api_v1_service_accounts__account_id__responses__response_id__get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "path", "name": "response_id", "required": true, "schema": { "title": "Response Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseObject" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Service Account Response", "tags": [ "service-accounts" ] } }, "/api/v1/service-accounts/{account_id}/resume": { "post": { "description": "Resume a paused account and its key. Nothing that failed while it was paused is replayed.", "operationId": "resume_service_account_api_v1_service_accounts__account_id__resume_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Resume Service Account", "tags": [ "service-accounts" ] } }, "/api/v1/service-accounts/{account_id}/summary": { "get": { "description": "One service account's turns, cost, refusals, mails sent and last activity over a window,\nin total and per instructor. Writes nothing.", "operationId": "summarize_service_account_api_v1_service_accounts__account_id__summary_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "description": "only activity at or after this instant (inclusive); with neither end, the current month", "in": "query", "name": "from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only activity at or after this instant (inclusive); with neither end, the current month", "title": "From" } }, { "description": "only activity before this instant (exclusive); with neither end, the current month", "in": "query", "name": "to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only activity before this instant (exclusive); with neither end, the current month", "title": "To" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountSummary" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Summarize Service Account", "tags": [ "service-accounts" ] } }, "/api/v1/service-accounts/{account_id}/workflow_runs": { "post": { "description": "Hand a service account a run: it acts as the account's key, for `sa:`, and names\nthis key and the person the request names as its instructor. Only management and the keys\non the account's instruct list may (`app.service_accounts.instructed_scope`).", "operationId": "instruct_workflow_run_api_v1_service_accounts__account_id__workflow_runs_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "idempotency-key", "required": false, "schema": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunInstructed" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Instruct Workflow Run", "tags": [ "workflows" ] } }, "/api/v1/skills": { "get": { "description": "List the calling key's tenant's skills.", "operationId": "list_skills_api_v1_skills_get", "parameters": [ { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "name", "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_SkillRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Skills", "tags": [ "skills" ] }, "post": { "description": "Create a skill from a SKILL.md package and its resources.", "operationId": "create_skill_api_v1_skills_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillWrite" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Skill", "tags": [ "skills" ] } }, "/api/v1/skills/{skill_id}": { "delete": { "description": "Delete a skill.", "operationId": "delete_skill_api_v1_skills__skill_id__delete", "parameters": [ { "in": "path", "name": "skill_id", "required": true, "schema": { "title": "Skill Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Skill", "tags": [ "skills" ] }, "get": { "description": "Fetch one skill.", "operationId": "get_skill_api_v1_skills__skill_id__get", "parameters": [ { "in": "path", "name": "skill_id", "required": true, "schema": { "title": "Skill Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Skill", "tags": [ "skills" ] }, "put": { "description": "Write a skill's package as its next version; 409 when the new package's name differs.", "operationId": "replace_skill_api_v1_skills__skill_id__put", "parameters": [ { "in": "path", "name": "skill_id", "required": true, "schema": { "title": "Skill Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillWrite" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Replace Skill", "tags": [ "skills" ] } }, "/api/v1/skills/{skill_id}/resources/{path}": { "get": { "description": "Fetch one packaged resource's content.", "operationId": "get_resource_api_v1_skills__skill_id__resources__path__get", "parameters": [ { "in": "path", "name": "skill_id", "required": true, "schema": { "title": "Skill Id", "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "title": "Path", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillResourceRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Resource", "tags": [ "skills" ] } }, "/api/v1/skills/{skill_id}/versions": { "get": { "description": "List a skill's versions, oldest first; cursor = version number.", "operationId": "list_versions_api_v1_skills__skill_id__versions_get", "parameters": [ { "in": "path", "name": "skill_id", "required": true, "schema": { "title": "Skill Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_SkillVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Versions", "tags": [ "skills" ] }, "post": { "description": "Add a version to a skill, as `PUT /skills/{skill_id}` does; `409` when the package's name\ndiffers.", "operationId": "create_version_api_v1_skills__skill_id__versions_post", "parameters": [ { "in": "path", "name": "skill_id", "required": true, "schema": { "title": "Skill Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillWrite" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Version", "tags": [ "skills" ] } }, "/api/v1/skills/{skill_id}/versions/{version}": { "get": { "description": "Fetch one specific version of a skill.", "operationId": "get_version_api_v1_skills__skill_id__versions__version__get", "parameters": [ { "in": "path", "name": "skill_id", "required": true, "schema": { "title": "Skill Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Version", "tags": [ "skills" ] } }, "/api/v1/sql_connectors": { "get": { "description": "List the calling key's tenant's SQL connectors.", "operationId": "list_sql_connectors_api_v1_sql_connectors_get", "parameters": [ { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "name", "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_SqlConnectorRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Sql Connectors", "tags": [ "sql connectors" ] }, "post": { "description": "Register a SQL connector under the calling key's tenant. 422 on `statement` for one this\ntool may not run; 503 when the deployment configures no key to seal the password with.", "operationId": "create_sql_connector_api_v1_sql_connectors_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SqlConnectorCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SqlConnectorRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Sql Connector", "tags": [ "sql connectors" ] } }, "/api/v1/sql_connectors/{connector_id}": { "delete": { "description": "Delete a SQL connector; its versions cascade.", "operationId": "delete_sql_connector_api_v1_sql_connectors__connector_id__delete", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Sql Connector", "tags": [ "sql connectors" ] }, "get": { "description": "Fetch one SQL connector.", "operationId": "get_sql_connector_api_v1_sql_connectors__connector_id__get", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SqlConnectorRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Sql Connector", "tags": [ "sql connectors" ] }, "patch": { "description": "Update what this connector runs, or its credential. A change to what it runs creates the\nnext version; the password, region, labels and metadata create none. `name` never changes.", "operationId": "update_sql_connector_api_v1_sql_connectors__connector_id__patch", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SqlConnectorUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SqlConnectorRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Sql Connector", "tags": [ "sql connectors" ] } }, "/api/v1/sql_connectors/{connector_id}/test": { "post": { "description": "Log in to the database of this connector's latest published version, or of the published\n`version` named, and run `SELECT 1`; store nothing. A failure is a 200 with `ok: false` and a\nfixed code: the request worked, the database did not answer.", "operationId": "test_sql_connector_api_v1_sql_connectors__connector_id__test_post", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "The version to test; by default the latest published one. A key is told a draft's number is not there; the management twin tests any version a person sees", "in": "query", "name": "version", "required": false, "schema": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The version to test; by default the latest published one. A key is told a draft's number is not there; the management twin tests any version a person sees", "title": "Version" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SqlConnectorTestRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Test Sql Connector", "tags": [ "sql connectors" ] } }, "/api/v1/sql_connectors/{connector_id}/versions": { "get": { "description": "List one connector's versions, newest first (`order=asc` reverses it); the cursor is a\nversion number.", "operationId": "list_sql_connector_versions_api_v1_sql_connectors__connector_id__versions_get", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "keyset direction: 'desc' (newest first, the default) or 'asc'", "in": "query", "name": "order", "required": false, "schema": { "default": "desc", "description": "keyset direction: 'desc' (newest first, the default) or 'asc'", "enum": [ "asc", "desc" ], "title": "Order", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_SqlConnectorVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Sql Connector Versions", "tags": [ "sql connectors" ] } }, "/api/v1/sql_connectors/{connector_id}/versions/{version}": { "get": { "description": "Fetch one version of a SQL connector.", "operationId": "get_sql_connector_version_api_v1_sql_connectors__connector_id__versions__version__get", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SqlConnectorVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Sql Connector Version", "tags": [ "sql connectors" ] } }, "/api/v1/subjects/tokens": { "post": { "description": "Mint a subject token: this key, narrowed to one person, for at most an hour.\n\nName the person with `subject` or hand Core an `assertion` -- a token one of this\norganisation's registered subject issuers signed -- and get back the same credential either\nway. The assertion is verified exactly as one in `X-Core-Subject` is and is stored nowhere;\nwhat the token carries is what its verified claims said, frozen for the token's life.\n\nHand the answer to that person's own device and store it nowhere: Core writes no row for it,\nso this body is the only copy there will ever be, and the only two ways it stops working are\nits own expiry and rotating the key that minted it.\n\nA token seals to at most 4096 characters; a mint whose attributes exceed that answers 422 on\n`subject.attributes`.", "operationId": "mint_subject_token_api_v1_subjects_tokens_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubjectTokenCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubjectTokenIssued" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Mint Subject Token", "tags": [ "subjects" ] } }, "/api/v1/subjects/{subject_id}": { "delete": { "description": "Erase everything Core holds for one person; the worker does it and this is the receipt.\n\n`202` for an id Core holds nothing for as well, and deliberately: a caller acting on a\nperson's request has to be able to ask without first being told whether that person is\nknown, and the job is a no-op that writes its `subject.erased` row with zeros. Asking twice\nwhile one erasure is still queued answers the same `erasure_id`. `409` while the organisation\nis under a legal hold.", "operationId": "erase_subject_api_v1_subjects__subject_id__delete", "parameters": [ { "in": "path", "name": "subject_id", "required": true, "schema": { "title": "Subject Id", "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubjectErasureQueued" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "the key does not hold `subjects`, or the id is outside the subject grammar; never \"nothing left\" -- an id Core holds something for and an id it holds nothing for both answer 202 here." }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Erase Subject", "tags": [ "subjects" ] }, "get": { "description": "What Core holds for one person on this organisation: counts per kind, and nothing else.\n\nThere is nothing else to answer with -- no name, no profile, no account, no list of ids\n(`docs/architecture/subjects.md` \"What Core never holds\"). An id Core holds nothing for is\n`404`, and so is one outside the `user` grammar: the route says nothing about which ids exist\nthat a caller did not already know.", "operationId": "get_subject_api_v1_subjects__subject_id__get", "parameters": [ { "in": "path", "name": "subject_id", "required": true, "schema": { "title": "Subject Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubjectHoldings" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Subject", "tags": [ "subjects" ] } }, "/api/v1/subscriptions": { "get": { "description": "List what this key's own organisation has installed.", "operationId": "list_own_subscriptions_api_v1_subscriptions_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_SubscriptionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Subscriptions", "tags": [ "sharing" ] }, "post": { "description": "Install a publication into this key's own organisation.", "operationId": "create_own_subscription_api_v1_subscriptions_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Own Subscription", "tags": [ "sharing" ] } }, "/api/v1/subscriptions/preview": { "post": { "description": "What installing this publication into this key's own organisation would mean, writing\nnothing.", "operationId": "preview_own_subscription_api_v1_subscriptions_preview_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallReport" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Preview Own Subscription", "tags": [ "sharing" ] } }, "/api/v1/subscriptions/{subscription_id}": { "delete": { "description": "Un-subscribe this key's own organisation from one publication.", "operationId": "delete_own_subscription_api_v1_subscriptions__subscription_id__delete", "parameters": [ { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Own Subscription", "tags": [ "sharing" ] }, "get": { "description": "Show one subscription of this key's own organisation.", "operationId": "get_own_subscription_api_v1_subscriptions__subscription_id__get", "parameters": [ { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Own Subscription", "tags": [ "sharing" ] }, "patch": { "description": "Supply parameter values, or accept a new version's terms, for one subscription of this\nkey's own organisation.", "operationId": "update_own_subscription_api_v1_subscriptions__subscription_id__patch", "parameters": [ { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Own Subscription", "tags": [ "sharing" ] } }, "/api/v1/subscriptions/{subscription_id}/members/{member}/fork": { "post": { "description": "Detach one member's copies of one subscription of this key's own organisation, so this\norganisation owns them.", "operationId": "fork_own_subscription_member_api_v1_subscriptions__subscription_id__members__member__fork_post", "parameters": [ { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } }, { "in": "path", "name": "member", "required": true, "schema": { "title": "Member", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Fork Own Subscription Member", "tags": [ "sharing" ] } }, "/api/v1/subscriptions/{subscription_id}/secrets": { "patch": { "description": "Supply or replace the credentials one subscription of this key's own organisation asks\nfor.", "operationId": "replace_own_subscription_secrets_api_v1_subscriptions__subscription_id__secrets_patch", "parameters": [ { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionSecrets" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Replace Own Subscription Secrets", "tags": [ "sharing" ] } }, "/api/v1/subscriptions/{subscription_id}/sync": { "post": { "description": "Ask for one subscription of this key's own organisation's own sync directly.", "operationId": "request_own_subscription_sync_api_v1_subscriptions__subscription_id__sync_post", "parameters": [ { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncQueued" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Request Own Subscription Sync", "tags": [ "sharing" ] } }, "/api/v1/tasks/{task_id}": { "get": { "description": "Fetch one task: its status and timings, and its result once it has ended.", "operationId": "get_task_api_v1_tasks__task_id__get", "parameters": [ { "in": "path", "name": "task_id", "required": true, "schema": { "title": "Task Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Task", "tags": [ "tasks" ] } }, "/api/v1/tasks/{task_id}/cancel": { "post": { "description": "Cancel a task and the run it is. Cancelling one already cancelled answers it unchanged;\none that ended otherwise is `409`.", "operationId": "cancel_task_api_v1_tasks__task_id__cancel_post", "parameters": [ { "in": "path", "name": "task_id", "required": true, "schema": { "title": "Task Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Cancel Task", "tags": [ "tasks" ] } }, "/api/v1/tasks/{task_id}/messages": { "post": { "description": "Send a message to a running agent task, which reads it before its next round; `409` for a\ntask that has ended.", "operationId": "send_task_message_api_v1_tasks__task_id__messages_post", "parameters": [ { "in": "path", "name": "task_id", "required": true, "schema": { "title": "Task Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskMessageCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Send Task Message", "tags": [ "tasks" ] } }, "/api/v1/thread-items": { "get": { "description": "Find the messages that say something, across every thread this request may list: newest\nfirst, each with the words around the match. A page reads a bounded batch of the history, so\nit may come back short or empty with a `next_cursor` all the same; `searched_to` says how far\nback it looked. Core's own messages, sealed words, tool calls and their results are never\nfound.", "operationId": "search_thread_items_api_v1_thread_items_get", "parameters": [ { "description": "the words to find: whole words, a quoted phrase, `or`, and `-word` to leave one out; required unless `metadata` is given", "in": "query", "name": "q", "required": false, "schema": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "the words to find: whole words, a quoted phrase, `or`, and `-word` to leave one out; required unless `metadata` is given", "title": "Q" } }, { "description": "key:value pairs an item's document must hold, every one; a value matches the string and the number or boolean it spells", "in": "query", "name": "metadata", "required": false, "schema": { "description": "key:value pairs an item's document must hold, every one; a value matches the string and the number or boolean it spells", "items": { "type": "string" }, "title": "Metadata", "type": "array" } }, { "description": "whose documents: a person's id; a subject token's own and no other", "in": "query", "name": "metadata_by", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "whose documents: a person's id; a subject token's own and no other", "title": "Metadata By" } }, { "description": "key:value pairs the thread's `metadata` must hold; all must match", "in": "query", "name": "thread_metadata", "required": false, "schema": { "description": "key:value pairs the thread's `metadata` must hold; all must match", "items": { "type": "string" }, "title": "Thread Metadata", "type": "array" } }, { "description": "search this one thread only", "in": "query", "name": "thread_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "search this one thread only", "title": "Thread Id" } }, { "description": "only items this author wrote", "in": "query", "name": "role", "required": false, "schema": { "anyOf": [ { "enum": [ "user", "assistant", "developer" ], "type": "string" }, { "type": "null" } ], "description": "only items this author wrote", "title": "Role" } }, { "description": "only items written at or after this instant", "in": "query", "name": "from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only items written at or after this instant", "title": "From" } }, { "description": "only items written before this instant", "in": "query", "name": "to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only items written before this instant", "title": "To" } }, { "description": "most items to answer", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "most items to answer", "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadItemSearchPage" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Search Thread Items", "tags": [ "threads" ] } }, "/api/v1/threads": { "get": { "description": "List the calling key's tenant's threads, optionally filtered by metadata (every pair\ngiven must match).", "operationId": "list_threads_api_v1_threads_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "key:value pairs to filter on; all must match", "in": "query", "name": "metadata", "required": false, "schema": { "description": "key:value pairs to filter on; all must match", "items": { "type": "string" }, "title": "Metadata", "type": "array" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ThreadRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Threads", "tags": [ "threads" ] }, "post": { "description": "Create a thread, optionally seeded with items and starting with a copy of another thread's\nworking state.", "operationId": "create_thread_api_v1_threads_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Thread", "tags": [ "threads" ] } }, "/api/v1/threads/{thread_id}": { "delete": { "description": "Delete a thread: its items cascade; a response that referenced it keeps its own row with\n`thread_id` cleared.", "operationId": "delete_thread_api_v1_threads__thread_id__delete", "parameters": [ { "in": "path", "name": "thread_id", "required": true, "schema": { "title": "Thread Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Thread", "tags": [ "threads" ] }, "get": { "description": "Fetch one thread.", "operationId": "get_thread_api_v1_threads__thread_id__get", "parameters": [ { "in": "path", "name": "thread_id", "required": true, "schema": { "title": "Thread Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Thread", "tags": [ "threads" ] }, "patch": { "description": "Replace a thread's metadata.", "operationId": "update_thread_api_v1_threads__thread_id__patch", "parameters": [ { "in": "path", "name": "thread_id", "required": true, "schema": { "title": "Thread Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Thread", "tags": [ "threads" ] } }, "/api/v1/threads/{thread_id}/items": { "get": { "description": "List a thread's items, oldest first; cursor = position.", "operationId": "list_items_api_v1_threads__thread_id__items_get", "parameters": [ { "in": "path", "name": "thread_id", "required": true, "schema": { "title": "Thread Id", "type": "string" } }, { "description": "start at this item of the thread, itself included -- an episode's first item, say; one the thread does not hold is 404", "in": "query", "name": "from_item", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "start at this item of the thread, itself included -- an episode's first item, say; one the thread does not hold is 404", "title": "From Item" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_Annotated_Union_ThreadMessage__ThreadReasoning__ThreadFunctionCall__ThreadCustomToolCall__ToolResultRead___FieldInfo_annotation_NoneType__required_True__discriminator__type____" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Items", "tags": [ "threads" ] }, "post": { "description": "Append items to a thread.", "operationId": "append_items_api_v1_threads__thread_id__items_post", "parameters": [ { "in": "path", "name": "thread_id", "required": true, "schema": { "title": "Thread Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppendItems" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemList" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Append Items", "tags": [ "threads" ] } }, "/api/v1/threads/{thread_id}/items/{item_id}": { "get": { "description": "Fetch one item.\n\n404 for a message Core itself authored -- the system preamble, an operator notice, a\nretrieval tool's fixed sentence -- because none of them is an item a caller is ever shown,\nso none has a read model to answer with (`app.responses.core_items.item_to_read`).", "operationId": "get_item_api_v1_threads__thread_id__items__item_id__get", "parameters": [ { "in": "path", "name": "thread_id", "required": true, "schema": { "title": "Thread Id", "type": "string" } }, { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "discriminator": { "mapping": { "custom_tool_call": "#/components/schemas/ThreadCustomToolCall", "function_call": "#/components/schemas/ThreadFunctionCall", "function_call_output": "#/components/schemas/ToolResultRead", "message": "#/components/schemas/ThreadMessage", "reasoning": "#/components/schemas/ThreadReasoning" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ThreadMessage" }, { "$ref": "#/components/schemas/ThreadReasoning" }, { "$ref": "#/components/schemas/ThreadFunctionCall" }, { "$ref": "#/components/schemas/ThreadCustomToolCall" }, { "$ref": "#/components/schemas/ToolResultRead" } ], "title": "Response Get Item Api V1 Threads Thread Id Items Item Id Get" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Item", "tags": [ "threads" ] } }, "/api/v1/threads/{thread_id}/items/{item_id}/metadata": { "delete": { "description": "Remove the document of the person this request is for from one item; `404` when she\nwrote none.", "operationId": "remove_item_metadata_api_v1_threads__thread_id__items__item_id__metadata_delete", "parameters": [ { "in": "path", "name": "thread_id", "required": true, "schema": { "title": "Thread Id", "type": "string" } }, { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Remove Item Metadata", "tags": [ "threads" ] }, "get": { "description": "The documents on one item, one per person; a subject token reads its own alone.", "operationId": "list_item_metadata_api_v1_threads__thread_id__items__item_id__metadata_get", "parameters": [ { "in": "path", "name": "thread_id", "required": true, "schema": { "title": "Thread Id", "type": "string" } }, { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ItemMetadataRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Item Metadata", "tags": [ "threads" ] }, "put": { "description": "Write or replace the document of the person this request is for on one message or\nrefusal -- the organisation's own when it names nobody; any other item is `422`. Reading the\nthread is enough: the document is the person's own row, not a change to the thread. Audited\nby item, never by what it says.", "operationId": "set_item_metadata_api_v1_threads__thread_id__items__item_id__metadata_put", "parameters": [ { "in": "path", "name": "thread_id", "required": true, "schema": { "title": "Thread Id", "type": "string" } }, { "in": "path", "name": "item_id", "required": true, "schema": { "title": "Item Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemMetadataWrite" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemMetadataRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Set Item Metadata", "tags": [ "threads" ] } }, "/api/v1/threads/{thread_id}/pseudonyms": { "get": { "description": "List what this thread hid from the model, oldest first; cursor = pseudonym id.", "operationId": "list_pseudonyms_api_v1_threads__thread_id__pseudonyms_get", "parameters": [ { "in": "path", "name": "thread_id", "required": true, "schema": { "title": "Thread Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_PseudonymRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Pseudonyms", "tags": [ "pseudonyms" ] } }, "/api/v1/threads/{thread_id}/pseudonyms/{pseudonym_id}": { "delete": { "description": "Stop hiding this value in this thread: a false positive the owning key has corrected.\n\nThe row stays, so its placeholder is never issued to a different value -- every earlier item\nin the thread that a model read under it still means what it meant. From the next turn on the\nvalue is left in clear.", "operationId": "suppress_pseudonym_api_v1_threads__thread_id__pseudonyms__pseudonym_id__delete", "parameters": [ { "in": "path", "name": "thread_id", "required": true, "schema": { "title": "Thread Id", "type": "string" } }, { "in": "path", "name": "pseudonym_id", "required": true, "schema": { "title": "Pseudonym Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Suppress Pseudonym", "tags": [ "pseudonyms" ] } }, "/api/v1/threads/{thread_id}/state": { "get": { "description": "Read a thread's working state.", "operationId": "get_thread_state_api_v1_threads__thread_id__state_get", "parameters": [ { "in": "path", "name": "thread_id", "required": true, "schema": { "title": "Thread Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadStateRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Thread State", "tags": [ "threads" ] }, "patch": { "description": "Merge a JSON merge patch into a thread's working state.", "operationId": "patch_thread_state_api_v1_threads__thread_id__state_patch", "parameters": [ { "in": "path", "name": "thread_id", "required": true, "schema": { "title": "Thread Id", "type": "string" } }, { "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "in": "header", "name": "If-Match", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "title": "If-Match" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "a JSON merge patch (RFC 7396): a member set to null is removed, an object merges into the object beside it, anything else replaces", "title": "Body", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadStateRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Patch Thread State", "tags": [ "threads" ] }, "put": { "description": "Replace a thread's working state whole.", "operationId": "put_thread_state_api_v1_threads__thread_id__state_put", "parameters": [ { "in": "path", "name": "thread_id", "required": true, "schema": { "title": "Thread Id", "type": "string" } }, { "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "in": "header", "name": "If-Match", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The version of the document this write was prepared from, as the read answered it (a policy document's version or policy_version, an organisation's metadata_version), quoted or bare; a comma-separated list passes when any member is the stored version, and `*` passes whatever is stored. When none matches the write is refused with 409 and changes nothing. Left out, the write is not held to a version", "title": "If-Match" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "the thread's whole new working state, a JSON object", "title": "Body", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadStateRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Put Thread State", "tags": [ "threads" ] } }, "/api/v1/threads/{thread_id}/summaries": { "get": { "description": "List the compaction summaries of a thread, oldest stretch first; cursor = through\nposition.", "operationId": "list_summaries_api_v1_threads__thread_id__summaries_get", "parameters": [ { "in": "path", "name": "thread_id", "required": true, "schema": { "title": "Thread Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ThreadSummaryRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Summaries", "tags": [ "threads" ] } }, "/api/v1/threads/{thread_id}/tasks": { "get": { "description": "List a thread's tasks, oldest first.", "operationId": "list_thread_tasks_api_v1_threads__thread_id__tasks_get", "parameters": [ { "in": "path", "name": "thread_id", "required": true, "schema": { "title": "Thread Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_TaskRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Thread Tasks", "tags": [ "tasks" ] } }, "/api/v1/tool-aliases": { "get": { "description": "List this tenant's tool aliases, by id.", "operationId": "list_tool_aliases_api_v1_tool_aliases_get", "parameters": [ { "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "in": "query", "name": "order", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "keyset direction: 'asc' or 'desc'. Absent is the list's own direction (asc) unsorted and 'asc' sorted", "title": "Order" } }, { "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "in": "query", "name": "sort", "required": false, "schema": { "anyOf": [ { "enum": [ "name", "created_at", "updated_at" ], "type": "string" }, { "type": "null" } ], "description": "the column to sort on; absent is the list's own order. A cursor is only good for the sort and order it was issued under", "title": "Sort" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ToolAliasRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Tool Aliases", "tags": [ "tool aliases" ] }, "post": { "description": "Register a tool alias under the calling key's tenant.", "operationId": "create_tool_alias_api_v1_tool_aliases_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolAliasCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolAliasRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Tool Alias", "tags": [ "tool aliases" ] } }, "/api/v1/tool-aliases/{alias_id}": { "delete": { "description": "Delete a tool alias. The target is untouched.", "operationId": "delete_tool_alias_api_v1_tool_aliases__alias_id__delete", "parameters": [ { "in": "path", "name": "alias_id", "required": true, "schema": { "title": "Alias Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Tool Alias", "tags": [ "tool aliases" ] }, "get": { "description": "Fetch one tool alias.", "operationId": "get_tool_alias_api_v1_tool_aliases__alias_id__get", "parameters": [ { "in": "path", "name": "alias_id", "required": true, "schema": { "title": "Alias Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolAliasRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Tool Alias", "tags": [ "tool aliases" ] }, "patch": { "description": "Update an alias's description, target or fixed arguments. `name` never changes.", "operationId": "update_tool_alias_api_v1_tool_aliases__alias_id__patch", "parameters": [ { "in": "path", "name": "alias_id", "required": true, "schema": { "title": "Alias Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolAliasUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolAliasRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Tool Alias", "tags": [ "tool aliases" ] } }, "/api/v1/tool-aliases/{alias_id}/versions": { "get": { "description": "List one alias's versions, newest first (`order=asc` reverses it); the cursor is a version\nnumber.", "operationId": "list_tool_alias_versions_api_v1_tool_aliases__alias_id__versions_get", "parameters": [ { "in": "path", "name": "alias_id", "required": true, "schema": { "title": "Alias Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "keyset direction: 'desc' (newest first, the default) or 'asc'", "in": "query", "name": "order", "required": false, "schema": { "default": "desc", "description": "keyset direction: 'desc' (newest first, the default) or 'asc'", "enum": [ "asc", "desc" ], "title": "Order", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ToolAliasVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Tool Alias Versions", "tags": [ "tool aliases" ] } }, "/api/v1/tool-aliases/{alias_id}/versions/{version}": { "get": { "description": "Fetch one version of an alias.", "operationId": "get_tool_alias_version_api_v1_tool_aliases__alias_id__versions__version__get", "parameters": [ { "in": "path", "name": "alias_id", "required": true, "schema": { "title": "Alias Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolAliasVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Tool Alias Version", "tags": [ "tool aliases" ] } }, "/api/v1/tools": { "get": { "description": "Every tool the calling key's tenant has, from every source, by qualified name.\n\nOnly the tools the rules over `tool` permit this request, by each tool's name and the labels\nit carries (`app.policy.labels`), whoever it names: a listing that answered differently from\nthe turn would show a tool the next round refuses. That is not a capability narrowing, which\nthis listing deliberately does not do: which tools exist is a question about the\norganisation.\n\nFiltered in Python, which is what the catalogue is: it is assembled in memory from a handful\nof small reads and paged in memory too, so there is no page query to cut this into.", "operationId": "list_tools_api_v1_tools_get", "parameters": [ { "description": "only tools from this source", "in": "query", "name": "source", "required": false, "schema": { "anyOf": [ { "enum": [ "api", "mcp", "mail", "knowledge", "memory", "datastore", "script", "function", "sql", "builtin", "core", "alias", "agent" ], "type": "string" }, { "type": "null" } ], "description": "only tools from this source", "title": "Source" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ToolRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Tools", "tags": [ "tools" ] } }, "/api/v1/tools/search": { "post": { "description": "The catalogue ranked against `query`, best first: by meaning and keyword, or by keyword\nalone where this caller has no embedding model it may use.\n\nThe same person view as `GET /tools`: a request naming a person ranks only the tools the\nrules over `tool` permit her. Meters the query's embedding, and any description it embedded\nfor the index; `429` at the monthly cap.", "operationId": "search_tools_api_v1_tools_search_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolSearch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolSearchRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Search Tools", "tags": [ "tools" ] } }, "/api/v1/tools/{name}": { "get": { "description": "One tool by its qualified name.\n\nA tool this request's person does not reach answers what a tool that does not exist answers,\nwhich is what every refusal on this axis answers\n(`docs/architecture/identity.md#out-of-scope-answers-404-not-403`).", "operationId": "get_tool_api_v1_tools__name__get", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Tool", "tags": [ "tools" ] } }, "/api/v1/tools/{name}/background": { "delete": { "description": "Make one tool Core supplies never run in the background. Idempotent.", "operationId": "delete_tool_background_api_v1_tools__name__background_delete", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Tool Background", "tags": [ "tool background" ] }, "get": { "description": "How this organisation lets one tool Core supplies run in the background: `never` when it\nhas said nothing.", "operationId": "get_tool_background_api_v1_tools__name__background_get", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolBackground" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Tool Background", "tags": [ "tool background" ] }, "put": { "description": "Say how one tool Core supplies may run in the background, replacing what was said before.\n`never` removes the setting.", "operationId": "set_tool_background_api_v1_tools__name__background_put", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolBackground" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolBackground" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Set Tool Background", "tags": [ "tool background" ] } }, "/api/v1/tools/{name}/call": { "post": { "description": "Run one tool with the given arguments, as this key, and answer the call and its result.\n\nThe tool is resolved exactly as a turn naming it in `tools[]` resolves it, so the refusals are\nthat request's own: `404` for a name this tenant has no tool for, `422` for a source whose\ncapability is off or a `version` on anything but an `api__` or `script__` tool.\n`builtin__subagent` and `builtin__load_skill` are `422`: there is no turn here for either to\nbelong to. A key whose policy requires an agent is `403` before any of that: a call outside\nevery turn runs outside every agent. A `core__call_tool` a turn dispatched is the exception,\nbecause that turn named one.\n\nOnce resolved, the call answers `200` -- a refusal by policy, a timeout and a tool that\nfailed are results, carrying the status, the fixed code and the sentence a model would have\nread, because that is what the call came to rather than something wrong with the request.\nOne refusal is not a result: a tool that would embed while the key or its organisation is at\nits monthly cost cap answers that cap's own `429` with `Retry-After`, as a search and a turn\ndo.\n\nA request that names a **person** -- in `X-Core-Subject`, or with a credential bound to one --\nruns the tool for her: a tool her `tool` rules refuse answers what `GET /tools/{name}` answers\nher, `404`.\n\nCalled from inside a turn -- as `core__call_tool`, or over Core's API as an MCP tool -- no\noutput carries its bytes: each is listed with `data: null` and noted in `text`, because the\nwhole answer becomes text a model reads.", "operationId": "call_tool_api_v1_tools__name__call_post", "parameters": [ { "description": "the tool's qualified name, as `GET /tools` lists it", "in": "path", "name": "name", "required": true, "schema": { "description": "the tool's qualified name, as `GET /tools` lists it", "maxLength": 64, "title": "Name", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolCallRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectToolCallRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Call Tool", "tags": [ "tools" ] } }, "/api/v1/tools/{name}/cover": { "delete": { "description": "Remove the picture on one tool. Idempotent: a tool that had none is `204` too.", "operationId": "delete_tool_cover_api_v1_tools__name__cover_delete", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Tool Cover", "tags": [ "covers" ] }, "get": { "description": "The cover of one tool, as bytes.\n\n`404` when this tool carries none of its own -- including when its *server* has one, which\nthe catalogue entry already says with `cover.from: source`, so a console asks the server's\nroute rather than this one -- and `404` for a tool this request's person does not reach, which\nis what its own entry answers.", "operationId": "get_tool_cover_api_v1_tools__name__cover_get", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } } }, "description": "The cover image." }, "304": { "description": "The caller's copy is current." }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Tool Cover", "tags": [ "covers" ] }, "put": { "description": "Put a picture on one tool, replacing whatever was there.", "operationId": "set_tool_cover_api_v1_tools__name__cover_put", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "The image itself, as the whole body: a PNG, a JPEG or a WebP. Send its own type as `Content-Type` -- what decides acceptance is the bytes, not the header.", "required": true }, "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "415": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem415", "type": "object" } } }, "description": "Unsupported Media Type" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Set Tool Cover", "tags": [ "covers" ] } }, "/api/v1/toolsets": { "get": { "description": "List this tenant's toolsets, stored and implicit, by name.", "operationId": "list_toolsets_api_v1_toolsets_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ToolsetRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Toolsets", "tags": [ "toolsets" ] }, "post": { "description": "Register a toolset under the calling key's tenant.", "operationId": "create_toolset_api_v1_toolsets_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolsetCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolsetRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Toolset", "tags": [ "toolsets" ] } }, "/api/v1/toolsets/{toolset_id}": { "delete": { "description": "Delete a toolset.", "operationId": "delete_toolset_api_v1_toolsets__toolset_id__delete", "parameters": [ { "in": "path", "name": "toolset_id", "required": true, "schema": { "title": "Toolset Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Toolset", "tags": [ "toolsets" ] }, "get": { "description": "Fetch one toolset.", "operationId": "get_toolset_api_v1_toolsets__toolset_id__get", "parameters": [ { "in": "path", "name": "toolset_id", "required": true, "schema": { "title": "Toolset Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolsetRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Toolset", "tags": [ "toolsets" ] }, "patch": { "description": "Update a toolset's description or globs. `name` never changes.", "operationId": "update_toolset_api_v1_toolsets__toolset_id__patch", "parameters": [ { "in": "path", "name": "toolset_id", "required": true, "schema": { "title": "Toolset Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolsetUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolsetRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Toolset", "tags": [ "toolsets" ] } }, "/api/v1/toolsets/{toolset_id}/cover": { "delete": { "description": "Remove the picture on one toolset.", "operationId": "delete_toolset_cover_api_v1_toolsets__toolset_id__cover_delete", "parameters": [ { "in": "path", "name": "toolset_id", "required": true, "schema": { "title": "Toolset Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Toolset Cover", "tags": [ "covers" ] }, "get": { "description": "The cover of one toolset, as bytes -- the registration's own for the implicit toolset a\nregistered MCP server is.", "operationId": "get_toolset_cover_api_v1_toolsets__toolset_id__cover_get", "parameters": [ { "in": "path", "name": "toolset_id", "required": true, "schema": { "title": "Toolset Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } } }, "description": "The cover image." }, "304": { "description": "The caller's copy is current." }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Toolset Cover", "tags": [ "covers" ] }, "put": { "description": "Put a picture on one toolset.", "operationId": "set_toolset_cover_api_v1_toolsets__toolset_id__cover_put", "parameters": [ { "in": "path", "name": "toolset_id", "required": true, "schema": { "title": "Toolset Id", "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "The image itself, as the whole body: a PNG, a JPEG or a WebP. Send its own type as `Content-Type` -- what decides acceptance is the bytes, not the header.", "required": true }, "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a write refused with the rows it contradicts: a `422` from what is\n**already stored** rather than from the request's own shape, or a `409` from a row still in\nuse elsewhere. Either way, the list of contradictions beside the `errors` every other problem\nof that status carries -- empty for the `422` a malformed body still answers, always empty for\nthe `409`, since nothing about a `ReferencedError`'s request is ever wrong.\n\nA subclass rather than a second unrelated body, so one route may answer either shape under one\ndeclared schema -- a malformed body still gets `errors` and no `conflicts`, and a body that is\nwell formed and contradicted (or still referenced) gets the reverse\n(`docs/architecture/api-conventions.md` \"A 422 that lists what is already stored\").", "properties": { "conflicts": { "default": [], "description": "the stored rows in the way, at most the first 100", "items": { "description": "One stored row a refused write contradicts.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "how many facts or rows are in the way, only where a number is meant (the entities or relations of a graph type a schema would drop)", "title": "Count" }, "id_or_name": { "description": "the id or name of that row, so it can be found", "title": "Id Or Name", "type": "string" }, "label_or_condition": { "description": "which part of it disagrees: a label's name, or the path of a condition", "title": "Label Or Condition", "type": "string" }, "reason": { "description": "human-readable explanation of why it is outside the write", "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "names_tool", "names_toolset", "delegates_to_agent", "links_skill", "selects_collection", "ingests_with_pipeline", "runs_pipeline", "fills_graph", "injects_memory", "extraction_on", "extraction_reads_agent", "has_entities", "has_relations", "names_routing_config", "default_routing_config", "outside_vocabulary", "pins_draft", "pins_missing_version" ], "type": "string" }, { "type": "null" } ], "description": "the way this row is in the way, from a closed set a client can switch on; the sentence in `reason` is for people and may be reworded", "title": "Reason Code" }, "where": { "description": "what kind of stored thing this is, such as `key.policy`", "title": "Where", "type": "string" } }, "required": [ "where", "id_or_name", "label_or_condition", "reason" ], "title": "ConflictEntry", "type": "object" }, "title": "Conflicts", "type": "array" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" }, "withheld": { "default": [], "description": "on a `409`, the users of the row this caller cannot read by their own read route, counted by kind and not listed in `conflicts`; empty when it reads them all", "items": { "description": "How many users of one kind a refusal leaves out because its caller cannot read them.", "properties": { "count": { "description": "how many of them there are, none of which is listed: no id and no name", "title": "Count", "type": "integer" }, "where": { "description": "what kind of stored thing these are, spelled as `conflicts[].where` (`agents`)", "title": "Where", "type": "string" } }, "required": [ "where", "count" ], "title": "WithheldEntry", "type": "object" }, "title": "Withheld", "type": "array" } }, "required": [ "title", "status", "errors" ], "title": "ConflictProblem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "415": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem415", "type": "object" } } }, "description": "Unsupported Media Type" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Set Toolset Cover", "tags": [ "covers" ] } }, "/api/v1/toolsets/{toolset_id}/tools": { "get": { "description": "The catalogue entries this toolset's globs match right now.", "operationId": "list_toolset_tools_api_v1_toolsets__toolset_id__tools_get", "parameters": [ { "in": "path", "name": "toolset_id", "required": true, "schema": { "title": "Toolset Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ToolRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Toolset Tools", "tags": [ "toolsets" ] } }, "/api/v1/toolsets/{toolset_id}/versions": { "get": { "description": "List one toolset's versions, newest first (`order=asc` reverses it); the cursor is a version\nnumber.", "operationId": "list_toolset_versions_api_v1_toolsets__toolset_id__versions_get", "parameters": [ { "in": "path", "name": "toolset_id", "required": true, "schema": { "title": "Toolset Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "keyset direction: 'desc' (newest first, the default) or 'asc'", "in": "query", "name": "order", "required": false, "schema": { "default": "desc", "description": "keyset direction: 'desc' (newest first, the default) or 'asc'", "enum": [ "asc", "desc" ], "title": "Order", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ToolsetVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Toolset Versions", "tags": [ "toolsets" ] } }, "/api/v1/toolsets/{toolset_id}/versions/{version}": { "get": { "description": "Fetch one version of a toolset.", "operationId": "get_toolset_version_api_v1_toolsets__toolset_id__versions__version__get", "parameters": [ { "in": "path", "name": "toolset_id", "required": true, "schema": { "title": "Toolset Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolsetVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Toolset Version", "tags": [ "toolsets" ] } }, "/api/v1/traces/{call_id}": { "get": { "description": "One call's whole document: the request the provider received, its answer, and Core's own\nreading of the context, the tools and the routing.\n\n**Audited.** One `trace.read` row is written and committed with the read, naming the reader\nand the call: a stored prompt is the most literal copy of what a caller sent, and who saw it\nis a question this deployment has to be able to answer (`docs/architecture/tracing.md`).", "operationId": "read_trace_api_v1_traces__call_id__get", "parameters": [ { "in": "path", "name": "call_id", "required": true, "schema": { "title": "Call Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelCallDocumentRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Read Trace", "tags": [ "tracing" ] } }, "/api/v1/uploads": { "get": { "description": "List this key's upload sessions, newest first; each carries how many parts it received,\nnot the parts themselves.", "operationId": "list_uploads_api_v1_uploads_get", "parameters": [ { "description": "only sessions in these states, repeatable; all when absent", "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "items": { "enum": [ "open", "completing", "completed", "failed", "aborted", "expired" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "only sessions in these states, repeatable; all when absent", "title": "Status" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_UploadSessionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Uploads", "tags": [ "files", "uploads" ] }, "post": { "description": "Open an upload session for a file too large for one request, or one that must survive a\ndropped connection. Everything that can be refused before a byte is refused here; send the\nparts with `PUT /uploads/{id}/parts/{n}`, then complete it.", "operationId": "create_upload_api_v1_uploads_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadSessionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadSessionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Upload", "tags": [ "files", "uploads" ] } }, "/api/v1/uploads/{session_id}": { "delete": { "description": "Abort an open session; its parts are dropped. `409` once it is completing or ended.", "operationId": "abort_upload_api_v1_uploads__session_id__delete", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Abort Upload", "tags": [ "files", "uploads" ] }, "get": { "description": "Read one upload session and the parts it has received, to resume after a dropped\nconnection or to see whether its completion has finished.", "operationId": "get_upload_api_v1_uploads__session_id__get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadSessionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Upload", "tags": [ "files", "uploads" ] } }, "/api/v1/uploads/{session_id}/complete": { "post": { "description": "Complete a session whose every part has arrived: it is `completing` until Core has\nassembled, hashed and stored the file, then `completed` with its `file_id`; poll\n`GET /uploads/{id}`. Asked again, it answers the session as it stands.", "operationId": "complete_upload_api_v1_uploads__session_id__complete_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadSessionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Complete Upload", "tags": [ "files", "uploads" ] } }, "/api/v1/uploads/{session_id}/parts/{part_number}": { "put": { "description": "Send one part. `409` once the session is no longer open, `413` past the part's size and\n`422` short of it; `503` with `Retry-After` while Core holds as many parts as it may.", "operationId": "put_upload_part_api_v1_uploads__session_id__parts__part_number__put", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "description": "The part's number, from 1", "in": "path", "name": "part_number", "required": true, "schema": { "description": "The part's number, from 1", "minimum": 1, "title": "Part Number", "type": "integer" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "The part itself, as the whole body: exactly `part_size_bytes` bytes, the last part the remainder. Sent again, it replaces the part received before.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadPartRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Put Upload Part", "tags": [ "files", "uploads" ], "x-body-limit": { "max_bytes": 16777216, "refusal": "A part is at most 16 MiB." } } }, "/api/v1/usage": { "get": { "description": "List the calling key's tenant's usage records, each with what it cost. The prices are\nread first: the request's session takes its connection at its first statement, so the two\nare never held at once.", "operationId": "list_own_usage_api_v1_usage_get", "parameters": [ { "description": "narrow to one request id", "in": "query", "name": "request_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one request id", "title": "Request Id" } }, { "description": "narrow to one response id", "in": "query", "name": "response_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one response id", "title": "Response Id" } }, { "description": "narrow to one usage kind", "in": "query", "name": "kind", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one usage kind", "title": "Kind" } }, { "description": "narrow to one key id", "in": "query", "name": "key_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one key id", "title": "Key Id" } }, { "description": "narrow to the rows metered for one person, by the id the calling application named them with; exact match, never a prefix", "in": "query", "name": "subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to the rows metered for one person, by the id the calling application named them with; exact match, never a prefix", "title": "Subject" } }, { "description": "only usage recorded at or after this instant (inclusive)", "in": "query", "name": "from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only usage recorded at or after this instant (inclusive)", "title": "From" } }, { "description": "only usage recorded before this instant (exclusive)", "in": "query", "name": "to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only usage recorded before this instant (exclusive)", "title": "To" } }, { "description": "narrow to the rows the turns of one agent wrote, by its name; exact match, and a nested agent turn's rows name the nested agent", "in": "query", "name": "agent", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to the rows the turns of one agent wrote, by its name; exact match, and a nested agent turn's rows name the nested agent", "title": "Agent" } }, { "description": "narrow to the rows one helper's work wrote, by its name -- a caller's own helper as its turns named it, or `assist.` for one of Core's; exact match, never a prefix", "in": "query", "name": "helper", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to the rows one helper's work wrote, by its name -- a caller's own helper as its turns named it, or `assist.` for one of Core's; exact match, never a prefix", "title": "Helper" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } }, { "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "in": "query", "name": "order", "required": false, "schema": { "default": "asc", "description": "keyset direction: 'asc' (oldest first) or 'desc' (newest first)", "enum": [ "asc", "desc" ], "title": "Order", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_UsageRecordRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Own Usage", "tags": [ "usage" ] } }, "/api/v1/usage/by-subject": { "get": { "description": "Usage totals for the calling key's tenant, one per subject -- \"which people sit under this\nkey and what did each cost\" -- optionally narrowed to one key and/or a time window.\n\nRefused to a subject token (`Reach.REFUSED`, `app.subjects.reach`): a device in front of one\nperson reads that person's own totals through `GET /usage/summary` alone, never a list of\nwho else the organisation serves.", "operationId": "summarize_own_usage_by_subject_api_v1_usage_by_subject_get", "parameters": [ { "description": "narrow to one key id", "in": "query", "name": "key_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one key id", "title": "Key Id" } }, { "description": "only usage recorded at or after this instant (inclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "in": "query", "name": "from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only usage recorded at or after this instant (inclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "title": "From" } }, { "description": "only usage recorded before this instant (exclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "in": "query", "name": "to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only usage recorded before this instant (exclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "title": "To" } }, { "description": "at most this many subjects in items; the count in subjects is never cut", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "description": "at most this many subjects in items; the count in subjects is never cut", "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "true to split every subject's total, unattributed included, by usage kind in by_kind", "in": "query", "name": "by_kind", "required": false, "schema": { "default": false, "description": "true to split every subject's total, unattributed included, by usage kind in by_kind", "title": "By Kind", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageBySubject" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Summarize Own Usage By Subject", "tags": [ "usage" ] } }, "/api/v1/usage/caps": { "get": { "description": "The calling key's own monthly cap and its organisation's, each with what has been spent\nagainst it so far this calendar month (`app.audit.caps`). The caps of the organisations above,\nwhich stop the key as well, are not in the answer.\n\nBoth caps come from the scope, which already carries them, and both totals from the same\nsummary the organisation's own usage screen is costed by, so a cap and a screen can never\ndisagree about what a month cost. `unpriced` says how many rows in the period no price\ncovered: each of them counts as zero against the cap, and this is what stops a forgotten price\nfrom widening a budget in silence.\n\n`keys` holds exactly the calling key: a key may know what it is capped at and what its\norganisation is capped at -- it pays for both -- and not which other keys that organisation\nhas registered, which is a management question.", "operationId": "read_own_usage_caps_api_v1_usage_caps_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageCaps" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Read Own Usage Caps", "tags": [ "usage" ] } }, "/api/v1/usage/summary": { "get": { "description": "Usage totals for the calling key's tenant, grouped by kind, model and tool name, each with\nwhat it cost in euro at the price in force when each of its rows was recorded; optionally\nnarrowed to one key and/or a time window by `key_id`/`from`/`to`, exactly as the management\nsummary is (`app.audit.usage_summary.summarize_usage`).\n\nA subject token gets the same totals for its own person alone -- the bytes stored for them\nincluded, because a summary that mixed one person's spend with the organisation's storage\nwould be two answers in one body.\n\n`interval=day` adds `series`, one entry per UTC calendar day inside `from`/`to` -- both\nrequired together with it, and the window is capped at 366 UTC days, `422` naming `to`\nbeyond it (`app.audit.usage_series.series_days`).\n\nThe prices are read first, in a control session of their own, and handed to the summary as a\nvalue; the totals are then summed over Artific's own usage ledger, or over this tenant's\n`usagerecord` when the read is narrowed to one person, and costed in Python either way\n(`app.audit.usage_summary.summarize_usage`).", "operationId": "summarize_own_usage_api_v1_usage_summary_get", "parameters": [ { "description": "narrow to one key id", "in": "query", "name": "key_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to one key id", "title": "Key Id" } }, { "description": "only usage recorded at or after this instant (inclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "in": "query", "name": "from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only usage recorded at or after this instant (inclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "title": "From" } }, { "description": "only usage recorded before this instant (exclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "in": "query", "name": "to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "only usage recorded before this instant (exclusive); with neither `from` nor `to` named, the current UTC calendar month, which the organisation's month sums answer without reading a row", "title": "To" } }, { "description": "'day' adds a daily cost series to the response, one entry per UTC calendar day inside `from`/`to`, zero-filled where a day has no rows; `from` and `to` are required together with it and the window is capped at 366 UTC days", "in": "query", "name": "interval", "required": false, "schema": { "anyOf": [ { "const": "day", "type": "string" }, { "type": "null" } ], "description": "'day' adds a daily cost series to the response, one entry per UTC calendar day inside `from`/`to`, zero-filled where a day has no rows; `from` and `to` are required together with it and the window is capped at 366 UTC days", "title": "Interval" } }, { "description": "narrow to the rows one request metered -- every turn it ran, a nested agent turn's included, and every tool it invoked -- by the `X-Request-Id` its answer carried", "in": "query", "name": "request_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to the rows one request metered -- every turn it ran, a nested agent turn's included, and every tool it invoked -- by the `X-Request-Id` its answer carried", "title": "Request Id" } }, { "description": "narrow to the rows metered under one response id; a nested agent turn has an id of its own, so a whole request is `request_id`", "in": "query", "name": "response_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to the rows metered under one response id; a nested agent turn has an id of its own, so a whole request is `request_id`", "title": "Response Id" } }, { "description": "narrow to the rows the responses of one thread metered -- what the chat cost; a nested agent turn that ran outside the thread is not among them, its request is `request_id`. Read from the organisation's own rows, so a deleted thread no longer narrows, and a subject token reads its own person's rows inside the thread only", "in": "query", "name": "thread_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "narrow to the rows the responses of one thread metered -- what the chat cost; a nested agent turn that ran outside the thread is not among them, its request is `request_id`. Read from the organisation's own rows, so a deleted thread no longer narrows, and a subject token reads its own person's rows inside the thread only", "title": "Thread Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageSummary" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Summarize Own Usage", "tags": [ "usage" ] } }, "/api/v1/workflow_decisions": { "get": { "description": "The waiting decisions assigned to this key, or to the person this subject token is for,\nnewest first.", "operationId": "list_decisions_api_v1_workflow_decisions_get", "parameters": [ { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_WorkflowDecisionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Decisions", "tags": [ "workflows" ] } }, "/api/v1/workflow_runs": { "get": { "description": "The runs this key reaches, newest first.", "operationId": "list_runs_api_v1_workflow_runs_get", "parameters": [ { "description": "only runs of this workflow", "in": "query", "name": "workflow_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "only runs of this workflow", "title": "Workflow Id" } }, { "description": "only runs in this status", "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "enum": [ "queued", "running", "waiting", "completed", "failed", "cancelled", "expired" ], "type": "string" }, { "type": "null" } ], "description": "only runs in this status", "title": "Status" } }, { "description": "only runs this schedule, trigger, task or parent step started, by its id", "in": "query", "name": "trigger_id", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "only runs this schedule, trigger, task or parent step started, by its id", "title": "Trigger Id" } }, { "description": "only the runs the steps of this run started", "in": "query", "name": "parent_run_id", "required": false, "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "only the runs the steps of this run started", "title": "Parent Run Id" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_WorkflowRunRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Runs", "tags": [ "workflows" ] } }, "/api/v1/workflow_runs/{run_id}": { "get": { "description": "One run with its steps.", "operationId": "get_run_api_v1_workflow_runs__run_id__get", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunDetail" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Run", "tags": [ "workflows" ] } }, "/api/v1/workflow_runs/{run_id}/cancel": { "post": { "description": "Cancel a run and its open steps; idempotent, `409` once it ended otherwise.", "operationId": "cancel_run_api_v1_workflow_runs__run_id__cancel_post", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Cancel Run", "tags": [ "workflows" ] } }, "/api/v1/workflow_runs/{run_id}/steps/{step_id}/decision": { "post": { "description": "Answer a decision assigned to this key, or to the person this subject token is for.\n`403` for a caller who is not the assignee, `409` once it was answered or its deadline\npassed.", "operationId": "answer_decision_api_v1_workflow_runs__run_id__steps__step_id__decision_post", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "in": "path", "name": "step_id", "required": true, "schema": { "title": "Step Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowDecisionAnswer" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowStepRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Answer Decision", "tags": [ "workflows" ] } }, "/api/v1/workflow_triggers": { "get": { "description": "The triggers this key reaches, newest first.", "operationId": "list_triggers_api_v1_workflow_triggers_get", "parameters": [ { "description": "only triggers of this workflow, by name", "in": "query", "name": "workflow", "required": false, "schema": { "anyOf": [ { "maxLength": 48, "type": "string" }, { "type": "null" } ], "description": "only triggers of this workflow, by name", "title": "Workflow" } }, { "description": "only event triggers, or only webhook triggers", "in": "query", "name": "source", "required": false, "schema": { "anyOf": [ { "enum": [ "event", "webhook" ], "type": "string" }, { "type": "null" } ], "description": "only event triggers, or only webhook triggers", "title": "Source" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_WorkflowTriggerRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Triggers", "tags": [ "workflows" ] }, "post": { "description": "Create a trigger whose runs act as this key. `201` and a `Location`; a webhook trigger is\nanswered with its address and, this once, its signing secret.", "operationId": "create_trigger_api_v1_workflow_triggers_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowTriggerCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowTriggerSecret" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Trigger", "tags": [ "workflows" ] } }, "/api/v1/workflow_triggers/{trigger_id}": { "delete": { "description": "Delete a trigger; the runs it started stay.", "operationId": "delete_trigger_api_v1_workflow_triggers__trigger_id__delete", "parameters": [ { "in": "path", "name": "trigger_id", "required": true, "schema": { "title": "Trigger Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Trigger", "tags": [ "workflows" ] }, "get": { "description": "One trigger; a webhook trigger with its address and never its secret.", "operationId": "get_trigger_api_v1_workflow_triggers__trigger_id__get", "parameters": [ { "in": "path", "name": "trigger_id", "required": true, "schema": { "title": "Trigger Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowTriggerRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Trigger", "tags": [ "workflows" ] }, "patch": { "description": "Change a trigger; only the key its runs act as changes what a start uses.", "operationId": "update_trigger_api_v1_workflow_triggers__trigger_id__patch", "parameters": [ { "in": "path", "name": "trigger_id", "required": true, "schema": { "title": "Trigger Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowTriggerUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowTriggerRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Trigger", "tags": [ "workflows" ] } }, "/api/v1/workflow_triggers/{trigger_id}/rotate-secret": { "post": { "description": "Replace a webhook trigger's signing secret and answer the new one, once. Requests signed\nfrom here on verify only against it. `403` for a key other than the one its runs act as,\n`409` on an event trigger.", "operationId": "rotate_trigger_secret_api_v1_workflow_triggers__trigger_id__rotate_secret_post", "parameters": [ { "in": "path", "name": "trigger_id", "required": true, "schema": { "title": "Trigger Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowTriggerSecret" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Rotate Trigger Secret", "tags": [ "workflows" ] } }, "/api/v1/workflows": { "get": { "description": "List the workflows this key's rules permit, newest first.", "operationId": "list_workflows_api_v1_workflows_get", "parameters": [ { "description": "only workflows carrying this `name:value` label; repeat the parameter to require several", "in": "query", "name": "label", "required": false, "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "only workflows carrying this `name:value` label; repeat the parameter to require several", "title": "Label" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_WorkflowRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Workflows", "tags": [ "workflows" ] }, "post": { "description": "Create a workflow with its first version, checked whole before anything is stored and\ndecided as a `write` for the person the request names.", "operationId": "create_workflow_api_v1_workflows_post", "parameters": [ { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Workflow", "tags": [ "workflows" ] } }, "/api/v1/workflows/validate": { "post": { "description": "Check a graph and its input schema as a save would, storing nothing. Declared above\n`/workflows/{workflow_id}`, which would otherwise swallow the word.", "operationId": "validate_workflow_api_v1_workflows_validate_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowVersionWrite" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowValidation" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Validate Workflow", "tags": [ "workflows" ] } }, "/api/v1/workflows/{workflow_id}": { "delete": { "description": "Delete a workflow, its versions and its ended runs, decided for the person the request\nnames; `409` while a run is open.", "operationId": "delete_workflow_api_v1_workflows__workflow_id__delete", "parameters": [ { "in": "path", "name": "workflow_id", "required": true, "schema": { "title": "Workflow Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Delete Workflow", "tags": [ "workflows" ] }, "get": { "description": "One workflow and its latest version.", "operationId": "get_workflow_api_v1_workflows__workflow_id__get", "parameters": [ { "in": "path", "name": "workflow_id", "required": true, "schema": { "title": "Workflow Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Workflow", "tags": [ "workflows" ] }, "patch": { "description": "Change the description and the labels, decided as a `write` for the person the request\nnames.", "operationId": "update_workflow_api_v1_workflows__workflow_id__patch", "parameters": [ { "in": "path", "name": "workflow_id", "required": true, "schema": { "title": "Workflow Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Update Workflow", "tags": [ "workflows" ] } }, "/api/v1/workflows/{workflow_id}/runs": { "post": { "description": "Start a run as this key. `202`: the run is queued and its first advance with it.", "operationId": "start_run_api_v1_workflows__workflow_id__runs_post", "parameters": [ { "in": "path", "name": "workflow_id", "required": true, "schema": { "title": "Workflow Id", "type": "string" } }, { "in": "header", "name": "idempotency-key", "required": false, "schema": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunCreate" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "413": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem413", "type": "object" } } }, "description": "Request Entity Too Large" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem429", "type": "object" } } }, "description": "Too Many Requests" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Start Run", "tags": [ "workflows" ] } }, "/api/v1/workflows/{workflow_id}/versions": { "get": { "description": "The workflow's versions, newest first.", "operationId": "list_versions_api_v1_workflows__workflow_id__versions_get", "parameters": [ { "in": "path", "name": "workflow_id", "required": true, "schema": { "title": "Workflow Id", "type": "string" } }, { "description": "maximum number of rows to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "maximum number of rows to return", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "opaque cursor from a previous page's next_cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "opaque cursor from a previous page's next_cursor", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_WorkflowVersionRead_" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "List Versions", "tags": [ "workflows" ] }, "post": { "description": "Write the workflow's next version, decided as a `write` for the person the request names;\nruns already started keep the one they pinned.", "operationId": "create_version_api_v1_workflows__workflow_id__versions_post", "parameters": [ { "in": "path", "name": "workflow_id", "required": true, "schema": { "title": "Workflow Id", "type": "string" } }, { "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "in": "header", "name": "X-Core-Subject", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The person this request is for, either as a JSON object -- `{\"id\": \"anna\", \"attributes\": {\"department\": [\"payroll\"]}}` -- or as a compact JWS one of this organisation's registered subject issuers signed. A credential bound to another person refuses the request, and `user` on `POST /responses` is an alias of `id`.", "title": "X-Core-Subject" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowVersionWrite" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem403", "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/problem+json": { "schema": { "description": "Problem detail for a 422: the individual field failures alongside the summary.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "errors": { "description": "the fields that failed validation", "items": { "description": "One field-level validation failure.", "properties": { "field": { "description": "dotted path to the invalid field", "title": "Field", "type": "string" }, "message": { "description": "human-readable description of the failure", "title": "Message", "type": "string" }, "type": { "description": "machine-readable error type from the validator", "title": "Type", "type": "string" } }, "required": [ "field", "message", "type" ], "title": "FieldError", "type": "object" }, "title": "Errors", "type": "array" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status", "errors" ], "title": "ValidationProblem422", "type": "object" } } }, "description": "Unprocessable Entity" }, "503": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem503", "type": "object" } } }, "description": "Service Unavailable" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Create Version", "tags": [ "workflows" ] } }, "/api/v1/workflows/{workflow_id}/versions/{version}": { "get": { "description": "One version of the workflow.", "operationId": "get_version_api_v1_workflows__workflow_id__versions__version__get", "parameters": [ { "in": "path", "name": "workflow_id", "required": true, "schema": { "title": "Workflow Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowVersionRead" } } }, "description": "Successful Response" }, "401": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem401", "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem404", "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "description": "RFC 9457 problem detail: the body of every non-2xx response Core returns.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "human-readable explanation specific to this occurrence", "title": "Detail" }, "reason_code": { "anyOf": [ { "$ref": "#/components/schemas/ProblemReason" }, { "type": "null" } ], "description": "why the request was refused, as a word a client can switch on, where one status answers for more than one reason: `stale_version` on a `409` whose `If-Match` named a version that is no longer stored, `organisation_suspended` on a `403` for a valid key whose organisation is suspended, `computer_not_configured` on a `422` for a tool that runs on a computer where the deployment has no pool to run it on. Left out of every other problem. A value may be added: treat one you do not know as a plain problem of its status. The sentence in `detail` is for people and may be reworded" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "the X-Request-Id of the request that failed, when known", "title": "Request Id" }, "status": { "description": "the HTTP status code, repeated in the body", "title": "Status", "type": "integer" }, "title": { "description": "short, human-readable summary of the problem type", "title": "Title", "type": "string" }, "type": { "default": "about:blank", "description": "about:blank, or the kind's entry in the guide's error catalogue", "title": "Type", "type": "string" } }, "required": [ "title", "status" ], "title": "Problem409", "type": "object" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "ApiKeySecret": [] } ], "summary": "Get Version", "tags": [ "workflows" ] } } } }