Types

Every type the API sends and receives: 519 in all. Each page lists its fields (or values), shows an example, and links to the calls and types that use it.

Type	Kind	Description
AddMessageResult	object	What happened to a message you sent to an interaction run: whether the run was waiting for it, and where it sits in the conversation.
Agent	object	An agent: a model with standing instructions, a one-line summary and the tools it may use.
AgentCreateRequest	object	Creates an agent: a model with standing instructions, a one-line summary and the tools it may use.
AgentExternalOperationReference	object	A tool an agent may call in every interaction it takes part in.
AgentUpdateRequest	object	A new version of an agent.
AgentVersion	object	A version of an agent: its model, instructions, summary and tools.
AiModel	object	A model in Maitento’s catalogue, which agents name as provider.model.
AiModelOverride	object	A model a run uses for one agent in place of the one its definition names: either a model from Maitento’s catalogue (aiModelId) or one defined inline (customModel).
AiModelOverridePurpose	enum	Which of an agent’s models an override replaces.
AiModelOverrideRequest	object	Runs one agent on a different model for this run.
AiModelType	enum	What a model in the catalogue is for.
AiStreamingMessageType	enum	What a streamed piece of an interaction run is.
App	object	An app: a small Cogniscript program that runs on Maitento and orchestrates interactions, code pipelines, capsules and tools.
AppConsoleOutput	object	One piece of text an app run printed.
AppConsoleOutputType	enum	The kind of console output an app printed.
AppCreateRequest	object	Creates an app with no versions yet.
AppDataType	enum	The Cogniscript type of an app input or output.
AppInput	object	An input an app takes: one parameter of its main function.
AppOutput	object	A named output an app run set with one of the AppStateSetOutput… calls.
AppProcess	object	A run of an app: its inputs, status, console output, named outputs and return value.
AppProcessPauseType	enum	What kind of run a paused app run is waiting for (pauseAssociatedId names it).
AppProcessStartConfig	object	An automation action ($type is app) that starts an app run.
AppProcessStatus	enum	Where an app run is in its life.
AppProcessWithDetails	object	An app run with the names of its app and namespace, as run listings return it.
AppStartRequest	object	The body of an app start: its inputs, plus optional model keys, model overrides and web settings.
AppVersion	object	A version of an app: the inputs its main takes, the tools it pins and its time limit.
AuthenticateRequest	object	Signs in with an e-mail address and password.
AuthenticateResponse	object	A signed-in session: its token, the user it belongs to and their tenant’s name.
AuthenticationToken	object	A session token, sent as Authorization: Bearer <token>.
AutomatedAction	object	An automation: “when this happens, start that”.
AutomatedActionItem	object	One action of an automation: what it starts when triggered.
AutoTopUpApiRequest	object	Turns auto top-up on or off, with the balance that triggers it and how much it buys.
AutoTopUpView	object	A tenant’s auto top-up as its admins see it.
BatchEditFileRequest	object	A single file edit within a batch.
BatchEditFileResult	object	Result for a single file in a batch edit.
BatchEditRequest	object	Request for editing multiple files atomically.
BatchEditResponse	object	What a batch edit did, file by file.
BatchReadFileResult	object	Result for a single file in a batch read.
BatchReadRequest	object	Request for reading multiple files in one call.
BatchReadResponse	object	The files a batch read returned.
BillingCadence	enum	How often a subscription is paid for.
BillingCatalogue	object	The plans on sale now, to compare (plan W9).
BillingCatalogueTier	object	One plan a tenant can choose: what it includes and its list prices in the tenant’s currency.
BillingMeter	enum	What is being charged for.
BillingMeterStanding	object	How much of one allowance a tenant has used this billing period, in the meter’s base unit.
BillingNotice	object	A billing event in a tenant: it ran out of credit or got it back, used up an allowance, ran low on balance, or its plan changed (including a failed renewal payment and the reminders after it).
BillingNoticeKind	enum	What a billing notice is about.
BillingPendingChange	object	An upgrade waiting for its prorated payment, as the tenant sees it.
BillingScheduledChange	object	A downgrade or cancellation booked for the renewal, as the tenant sees it.
BillingStanding	object	Where a tenant stands with billing now (plan W9): its plan and its state, its balance, whether it can start work, any plan change on its way, and how much of each allowance it has used this billing period.
BuildAuthenticationMethod	enum	How the caller of a recorded build authenticated.
BuildConnectorsResponse	object	The connectors a build created, updated or left unchanged, by kind.
BuildEntityMode	enum	What a build did with one definition.
BuildEntityOfAgent	object	One definition in a build’s result, and what the build did with it.
BuildEntityOfApp	object	One definition in a build’s result, and what the build did with it.
BuildEntityOfCapsule	object	One definition in a build’s result, and what the build did with it.
BuildEntityOfCodePipeline	object	One definition in a build’s result, and what the build did with it.
BuildEntityOfLoom	object	One definition in a build’s result, and what the build did with it.
BuildEntityOfManagedInteraction	object	One definition in a build’s result, and what the build did with it.
BuildEntityOfMcpConnector	object	One definition in a build’s result, and what the build did with it.
BuildEntityOfMcpExternalOperation	object	One definition in a build’s result, and what the build did with it.
BuildEntityOfOneShotInteraction	object	One definition in a build’s result, and what the build did with it.
BuildEntityOfOpenApiConnector	object	One definition in a build’s result, and what the build did with it.
BuildEntityOfOpenApiExternalOperation	object	One definition in a build’s result, and what the build did with it.
BuildEntityOfRoundRobinInteraction	object	One definition in a build’s result, and what the build did with it.
BuildExternalOperationsResponse	object	The tools a build created, updated or left unchanged, by kind.
BuildInteractionsRequest	object	The interaction files of a build, by kind.
BuildInteractionsResponse	object	The interactions a build created, updated or left unchanged, by kind.
BuildOpenApiAndMcpRequest	object	The connector or tool files of a build, by kind.
BuildOutcome	enum	How a recorded build attempt ended.
BuildRecord	object	One attempt to validate or deploy a project into a namespace, recorded whatever its outcome: who, when, how long, what was sent (a list of files with hashes, and the files themselves up to a limit), the build log, and what a deploy produced.
BuildRecordCounts	object	How many of each kind a build request carried: always exact, even when the record’s file list or sources were truncated.
BuildRecordDeployedResource	object	One definition a deploy created, updated or left unchanged.
BuildRecordDiagnostic	object	One entry of a recorded build’s log: the same fields, under the same names, as the CompilationLogEntry the build returned.
BuildRecordFileKind	enum	Which part of a build request a source file was sent in.
BuildRecordItem	object	One source file of a recorded build, as the request carried it.
BuildRecordListRequest	object	The filters and paging for listing builds, all optional.
BuildRecordPage	object	One page of the build history, newest first.
BuildRecordResourceKind	enum	The kind of definition a deploy created, updated or left unchanged.
BuildRecordSource	object	The text of one source file of a recorded build, so the build can be re-opened or compared.
BuildRecordSummary	object	A build as a row in a list: everything but its files, sources, log, deployed list and validation failures, which only GET /builds/by-id/{id} returns.
BuildRecordValidationFailure	object	Why a Rejected build was refused: one entry of the 400’s validationFailures.
BuildRequest	object	A project’s files, sent to be validated or deployed into a namespace.
BuildRequestApp	object	One app of a build (or a code pipeline’s hooks): its code files and optional settings file.
BuildRequestCodePipeline	object	A code pipeline definition in a build: its pipeline-definition.json, with the folder’s @prompt(...) and @schema(...) includes already inlined.
BuildRequestItem	object	One .mtr file of a build: the definition’s name, its file name and its lines.
BuildResponse	object	The result of a build: whether it succeeded, its log, and each definition it created, updated or left unchanged.
Capsule	object	A capsule: the recipe for a short-lived Linux sandbox (packages, users, mounted file systems and secrets, and commands to run at start).
CapsuleOperationType	enum	What a command queued on a capsule run does: run a shell command, or change the running capsule.
CapsuleProcess	object	A run of a capsule: a live Linux sandbox you send commands to, with what it mounted, created and installed and every command’s result.
CapsuleProcessAddUserRequest	object	Creates a Linux user in a running capsule.
CapsuleProcessCommand	object	A command or operation sent to a capsule run, with its status and result.
CapsuleProcessCommandStatus	enum	Where a command queued on a capsule run is.
CapsuleProcessInstallPackageRequest	object	Installs a Debian package in a running capsule, with apt.
CapsuleProcessMountSecretRequest	object	Mounts a secret as a file in a running capsule.
CapsuleProcessMountVfsRequest	object	Mounts a virtual file system in a running capsule.
CapsuleProcessRunCommandRequest	object	Runs a shell command in a capsule run that has not ended; one sent while it is still starting runs once it is ready.
CapsuleProcessStartConfig	object	An automation action ($type is capsule) that starts a capsule run.
CapsuleProcessStartRequest	object	Starts a run of a capsule, optionally with different mounts and with commands to run once it is ready.
CapsuleProcessStatus	enum	Where a capsule run is in its life.
CapsuleProcessWithDetails	object	A capsule run with the names of its capsule and namespace, as a namespace’s run listing returns it.
CapsuleSecretMount	object	A secret written to a file in a capsule.
CapsuleStartupCommand	object	A command a capsule runs when it starts (startup in its .mtr file).
CapsuleUserDefinition	object	A Linux user a capsule creates when it starts.
CapsuleVersion	object	A version of a capsule: the packages, users, mounts and startup commands a run starts with, and how long it may last.
CapsuleVirtualFileSystemMount	object	A virtual file system mounted in a capsule.
CodeDiff	object	A set of code changes, file by file.
CodeDiffChange	object	One changed section (hunk) of a file.
CodeDiffChangeLine	object	One line of a changed section.
CodeDiffChangeLineType	enum	What happened to a line in a diff.
CodeDiffFile	object	One changed file in a diff.
CodeEngineType	enum	The coding tool (engine) that drives a code pipeline agent, and so which provider’s model key it uses.
CodePipeline	object	A code pipeline: a recipe for AI coding agents to work on your git repositories in phases and steps.
CodePipelineAgent	object	An AI coding agent in a code pipeline: the engine (coding tool) and model it runs on, its instructions, and the tools it may use.
CodePipelineAgentEnginePrompt	object	Extra system prompts for an agent that apply only when it runs on one engine, so its instructions can be tuned to each coding tool.
CodePipelineAgentRole	enum	What a code pipeline agent does.
CodePipelineApiKeyCredentials	object	An API key for a code pipeline engine, with where its traffic goes.
CodePipelineChallengeTurn	object	One round of a step’s “is it really done?” check (runChallengeLoop): what the agent said about its own work.
CodePipelineChildRef	object	A reference to one of a run’s tool calls, transcript entries or diffs, which are fetched separately: its id and its revision.
CodePipelineCreateRequest	object	A code pipeline’s definition, to create a pipeline or add a version to one.
CodePipelineCredentialFailure	object	A failure of one of your own credentials during a run.
CodePipelineEngineOutput	object	One call a step made to its coding tool: the exit code and both output streams, recorded whether it succeeded or failed.
CodePipelineGitHttpRepo	object	A git repository a code pipeline run clones and pushes over HTTPS.
CodePipelineGitSshRepo	object	A git repository a code pipeline run clones and pushes over SSH.
CodePipelineHostingMode	enum	Where an API key’s model is hosted.
CodePipelineHumanInteractionAnswerAuthor	object	The person who answered an agent’s question.
CodePipelineHumanInteractionRequest	object	A question an agent asked a person during a step.
CodePipelineHumanInteractionSuggestedAnswer	object	An answer an agent suggests for its own question.
CodePipelineOAuthCredentials	object	A coding tool’s sign-in (OAuth tokens from a subscription) for a code pipeline engine, used in place of an API key.
CodePipelineOutputFile	object	A file the agents wrote to the run’s output_files/ folder, uploaded to the run’s outputFilesPartitionId knowledge base.
CodePipelinePackageInstall	object	A package an agent installed during the run.
CodePipelinePhaseDefinition	object	A phase of a code pipeline: a group of steps that runs once the phases it depends on have finished.
CodePipelinePhaseExecution	object	How one phase of a code pipeline run is going, with its steps.
CodePipelinePhaseExecutionStatus	enum	Where a phase of a code pipeline run is.
CodePipelineProcess	object	A run of a code pipeline: its status, the repositories it works on, and each phase and step as it goes.
CodePipelineProcessAdditionalSteps	object	Steps to add to one of the pipeline’s phases for a single run, so one definition can do different work each run.
CodePipelineProcessAgentOverride	object	For one run, a different engine or model for one of the pipeline’s agents.
CodePipelineProcessAnswerRequest	object	An answer to a question an agent asked during a code pipeline run.
CodePipelineProcessContextEntry	object	One entry of an agent’s transcript in a code pipeline run: something it wrote, or its thinking.
CodePipelineProcessContextEntryKind	enum	What a transcript entry of a code pipeline run holds.
CodePipelineProcessCredentials	shapes	A credential a code pipeline run’s engines use: an API key ("apiKey") or a coding tool’s sign-in ("oauth").
CodePipelineProcessDiff	object	A code pipeline run’s changes, file by file and line by line.
CodePipelineProcessDiffRaw	object	A code pipeline run’s changes as unified diff text, as git produces it.
CodePipelineProcessMcpServer	object	An MCP server that runs from a repository’s checkout over standard input and output, so a run’s agents can call the repository’s own tools.
CodePipelineProcessPayloadsByIdsRequest	object	The tool calls and transcript entries of a run to fetch, by id: typically the ones the run’s references list that you don’t have, or have at an older revision.
CodePipelineProcessPayloadsResponse	object	Tool calls and transcript entries of a code pipeline run.
CodePipelineProcessRepo	shapes	A git repository for a code pipeline run, over SSH ("ssh") or HTTPS ("http").
CodePipelineProcessResumeWithPromptRequest	object	Resumes a code pipeline run that failed, was killed or has had its questions answered, with a prompt for the agent.
CodePipelineProcessStartConfig	object	An automation action ($type is codepipeline) that starts a code pipeline run.
CodePipelineProcessStartRequest	object	Starts a run of a code pipeline: its inputs, the repositories to work on, and any changes to the pipeline for this run.
CodePipelineProcessStatus	enum	Where a code pipeline run is.
CodePipelineProcessToolUse	object	One tool call an agent made during a code pipeline run: its input, its result and how long it took.
CodePipelineProcessUpdatedSummary	object	What the code-pipeline-process-updated event carries: a short summary of a code pipeline run that changed.
CodePipelineProcessVfsMount	object	A file system (VFS) mounted for a code pipeline run’s agents.
CodePipelineReviewPanel	object	A run’s panel of reviewers: the review steps in one phase, each with its own focus (lens).
CodePipelineReviewPanelMember	object	One reviewer on a review panel: its review step, the agent that runs it, its focus (lens), and the variable its review is stored in.
CodePipelineReviewRecheckPolicy	enum	Which reviewers on a review panel review again after a fix round, decided from what each found in the round before.
CodePipelineStepDefinition	object	A step of a code pipeline phase: one prompt to one agent.
CodePipelineStepExecution	object	How one step of a code pipeline run is going: its status, output, token usage, questions and the agent’s transcript.
CodePipelineStepExecutionStatus	enum	Where a step of a code pipeline run is.
CodePipelineStructuredOutput	object	The agent’s own summary of a step, asked for after the step (isStructuredOutput).
CodePipelineSystemPromptMode	enum	How a set of system prompts combines with the ones before it (the pipeline’s, then each agent’s).
CodePipelineTokenUsageEntry	object	A count of one type of token a step used, with the model and credential that used them.
CodePipelineUpdateRequest	object	A new definition for an existing code pipeline.
CodePipelineVersion	object	One version of a code pipeline’s definition: its agents, phases, inputs, tools and limits.
CodePipelineVfsBinding	object	A file system (VFS) a code pipeline declares for its agents.
CodePipelineVfsMode	enum	Whether a code pipeline’s agents can change a mounted file system.
CompactionType	enum	How an interaction summarises older parts of its conversation once it nears the model’s context window.
CompilationInputFile	object	A source file sent to a build: its name and its lines.
CompilationLogEntry	object	One message from a build, with where in the project it came from when it is about a file.
CompilationLogLevel	enum	How serious a build message is.
Connector	shapes	A connector: one endpoint, described once (its URL, request and response, and the kind of credential it needs).
ConnectorAuthenticationHeader	object	A credential sent with every call of a tool: a secret’s value, in an HTTP header.
ConnectorAuthenticationSecretInput	object	A run input that chooses the secret a tool sends with its calls: a run gives the id of a secret, such as one per customer, and the tool sends its value in an HTTP header.
ConnectorAuthenticationType	enum	The kind of credential a connector’s endpoint needs.
ConnectorBinding	object	A fixed value for one field or parameter of a tool’s calls.
ConnectorBindingInput	object	A run input whose value is written straight into a tool’s calls, such as a customer id, so the model never sees or chooses it.
ConnectorBindingInputType	enum	Where a run input’s value goes in a tool call.
ContextTrimmingMode	enum	What happens when an interaction’s conversation no longer fits the model’s context window.
ContractStatus	enum	The state of a tenant’s contract.
CreateAutomatedActionRequest	object	Creates an automation in a namespace: what it starts.
CredentialCloud	object	Where an Anthropic credential reaches Claude when it isn’t Anthropic’s own API: Amazon Bedrock in a region, or Google Vertex AI in a project and region.
CredentialCloudKind	enum	The cloud an Anthropic credential reaches Claude through, in place of Anthropic’s own API.
CredentialEndpointKind	enum	What kind of endpoint a credential calls.
CredentialHealth	object	How a credential has been behaving.
CredentialKeyTestResult	object	How one of a credential’s keys did in a test.
CredentialKind	enum	How a credential authenticates.
CredentialModel	object	A model a credential may serve.
CredentialOAuthTool	enum	The coding agent whose subscription an OAuth credential signs in to.
CredentialSignInFinishRequest	object	Finishes a subscription sign-in: Claude’s with the code Anthropic showed, Codex’s by polling (no code).
CredentialSignInResult	object	Where a subscription sign-in stands: still waiting for the person (Codex), or done, with the credential.
CredentialSignInStart	object	A started subscription sign-in: where the person goes to finish it, and the id to finish it with.
CredentialSignInStartRequest	object	Starts a subscription sign-in.
CredentialSignInStatus	enum
CredentialSignInTokensRequest	object	A subscription sign-in’s tokens that you already hold, made into an OAuth credential (or replacing the tokens of one made that way).
CredentialSnapshotEntry	object	One entry of a run’s credential stack as it stood when the run started: which credential, and this stack’s rules for it.
CredentialStack	object	A named, ordered list of credentials a run may use (collection credentialStack).
CredentialStackEntry	object	One place in a stack: a credential, plus this stack’s own rules for it.
CredentialStackRequest	object	A credential stack to create, or what an existing one should become (every field is replaced).
CredentialStackSnapshot	object	The credential stack a run uses, captured when it started: the stack, its version, where it was resolved from, and its entries with their rules.
CredentialStackSource	enum	Where a run’s credential stack came from, most specific first.
CredentialStackUsage	object	Where a credential stack is used, as defaults and by knowledge bases.
CredentialStackUser	object	A namespace or knowledge base that uses a credential stack.
CredentialTestResult	object	What a test of a credential found: each key was used to list the provider’s models at the credential’s endpoint.
CronSchedule	object	A schedule that triggers an automation: a cron expression split into fields, in UTC.
CurrentUserResponse	object	Who the caller is (GET /users/self): their user, their tenant, and the roles this session or API key is authorised with.
CurrentUserTenant	object	The tenant the calling user belongs to, as returned by GET /users/self.
DecayRate	enum	How quickly a thread frays each time it is put in front of an agent and goes unused.
DefaultCredentialStack	object	The stack runs use when nothing more specific names one: for the tenant, or for one namespace.
DeferredToolCall	object	A tool call that waits its turn: when a model asks for several tool calls at once and one of them needs approval, the calls after it wait here and run, in order, once that approval is decided.
DocumentTextExtractionFailedResponse	object	The body of a 422 for an uploaded file Maitento could not read usable text from, even after trying OCR where it could.
EditOperation	object	A single edit operation to perform on a file.
EditOperationResult	object	Result of a single edit operation.
EditRequest	object	Request for editing a file with one or more operations.
EditResponse	object	What an edit did, operation by operation, and the file after it.
EffectiveEntitlements	object	What a tenant is entitled to right now: its plan’s terms, with any terms agreed for this tenant applied on top.
EffectiveLane	object	A tenant’s concurrency on one lane type: what the tier includes, what was bought, the ceiling, and the resulting limit.
EmbeddedVectorSearchRequest	object	Searches a partition’s files for passages whose meaning is close to a query.
EmbeddingModelDefinition	object	One embedding model Maitento can index and search with, and the limits that decide how text is cut into chunks before it reaches it.
EmbeddingProvider	enum	The provider an embedding model is served by.
EmbeddingsSearchResult	object	One passage a search found, with the file it came from.
ExecutionHistoryEntry	object	One run an automation started, or tried to start: what triggered it and how it ended.
ExecutionOutcome	enum	How a run an automation started ended.
ExecutionTriggerType	enum	What triggered an automation.
ExternalOperation	shapes	A tool (external operation): what an agent sees and calls.
FileByteContentRequest	object	A file’s content as bytes.
FileLinesContentRequest	object	A file’s content as lines of text.
FileSystemDirectory	object	A directory in a file system listing.
FileSystemEntry	shapes	An entry in a file system directory listing: a file or a directory.
FileSystemFile	object	A file in a file system listing.
FileTextContentRequest	object	A file’s content as text.
FileTextResponse	object	The text extracted from a file.
FindRequest	object	Request for finding files with optional glob pattern and content search.
FindResponse	object	The files and directories a find matched.
FindResultEntry	object	One file or directory a find matched.
GrepMatch	object	Represents a single grep match within a file.
HttpMethod	object
HumanChatMode	enum	Whether a person takes part in an interaction’s conversation, and when they speak.
IngestedFile	object	A file uploaded to a partition (or downloaded into one by an agent’s web tools): its extracted text, and how far it has got through being described, chunked and embedded for search.
IngestedFileIndexingFailure	object	Why a file cannot be indexed (made searchable) until someone acts: no embedding key for its knowledge base’s provider, or every key failed.
IngestedFileListItem	object	A file as a partition’s file listing returns it: everything about the file and how far it has got through processing, without the extracted text (which can be megabytes).
IngestedFilePage	object	One page of a partition’s files, newest first.
IngestedFileSummary	object	A file’s name, size and type.
IngestedFileType	enum	What kind of document a file is, which decides how its text is extracted.
IngestedFileWebSource	object	Where a web download came from, and which run’s agent fetched it.
InlineAiModelDefinition	object	A model you define in full when you start a run, for one that isn’t in Maitento’s catalogue, such as a model on your own endpoint.
Interaction	shapes	An interaction: agents working on a task together, defined once and run many times.
InteractionAddMessageRequest	object	A person’s message to an interaction run, such as a reply in a chat.
InteractionAddSystemMessageRequest	object	A system message for a run that hasn’t ended, to give its agents more context without restarting it.
InteractionAgentBinding	object	An agent taking part in an interaction (a participant), under the name it has there, with any tools it gets on top of its agent’s own.
InteractionAgentWebAccess	object	A participant’s web tools as its interaction sets them: each one true (on), false (off) or null (as the agent allows).
InteractionApproveToolCallRequest	object	Approves a tool call that is waiting for a person’s approval, so it runs and the run carries on.
InteractionContextSettings	object	How an interaction keeps its conversation within the model’s context window, and how many rounds of tool calls an agent may make in one turn.
InteractionInputType	enum	The type of value an interaction input takes.
InteractionMessageStartConfig	object	An automation action ($type is interaction-message) that posts a message into a running interaction, for example to wake it or move it on when something happens.
InteractionProcess	object	A run of an interaction: what it was started with, where it has got to, the whole conversation and its answer.
InteractionProcessContext	object	An interaction run’s conversation, grouped by kind of item.
InteractionProcessContextAgentMessage	object	Something an agent said in the conversation.
InteractionProcessContextAgree	object	A vote for a vote proposal or a proposed final answer, by an agent or a person.
InteractionProcessContextAuthor	object	Who wrote an item of a run’s conversation.
InteractionProcessContextAuthorType	enum	What kind of author wrote an item of a run’s conversation.
InteractionProcessContextDirectQuestionAnswer	object	An agent’s answer to a question another agent asked it directly.
InteractionProcessContextDirectQuestionAsk	object	A question one agent asked another directly.
InteractionProcessContextDisagree	object	A vote against a vote proposal or a proposed final answer, by an agent or a person, with the reason.
InteractionProcessContextHumanMessage	object	A message a person sent to the run.
InteractionProcessContextInjectedSystemMessage	object	A system message added to the run while it was going, to give its agents more context without restarting it.
InteractionProcessContextNoAction	object	An agent passing its turn without saying anything.
InteractionProcessContextOrchestratorMessage	object	A message from Maitento running the conversation, such as handing an agent its turn.
InteractionProcessContextSolutionProposal	object	An agent’s proposed final answer, which the others (and a person, when included) vote on.
InteractionProcessContextSummary	object	A summary of the earlier conversation, written when it neared the model’s context window.
InteractionProcessContextSystemPrompt	object	A system prompt the run’s agents were given.
InteractionProcessContextToolCall	object	A tool call an agent made.
InteractionProcessContextToolResult	object	The result of a tool call.
InteractionProcessContextVoteProposal	object	An agent putting something to a vote.
InteractionProcessCredential	object	A model provider API key a run was started with (the key itself is never returned).
InteractionProcessCredentialFailure	object	A model key that failed during a run, so the run moved on to the next one: which key, why and when.
InteractionProcessCredentialRequest	object	A model provider API key of yours for a run to use.
InteractionProcessManagedDispatch	object	A managed interaction’s dispatch that a person’s approval interrupted: the agent’s tool call waits for the approval, and so does the run.
InteractionProcessStartConfig	object	An automation action ($type is interaction) that starts an interaction run.
InteractionProcessStartRequest	object	Starts a run of an interaction: its inputs, and anything this run does differently from the definition.
InteractionProcessStatus	enum	Where an interaction run has got to.
InteractionProcessSwarm	object	A run’s place in a tree of sub-interactions.
InteractionProcessTokenUsage	object	The tokens one agent turn of an interaction run used: the breakdown by kind (input, output, cache, reasoning), the provider and model that served it, the agent, and the key it ran on.
InteractionProcessToolResult	object	The result of one tool call in an interaction run, kept apart from the run so the run stays small.
InteractionProcessWithDetails	object	An interaction run, with the names of its interaction and namespace.
InteractionRejectToolCallRequest	object	Rejects a tool call that is waiting for a person’s approval: the call does not run, and the agent is told why.
InteractionRoutingDecision	object	One router’s choice for one turn: which agent took the participant’s turn, and why.
InteractionStreamUserNotification	object	What the interaction-process-stream event carries: a piece of an agent’s reply as the model writes it, or the name of a tool it is calling.
InteractionSubInteraction	object	A sub-interaction a run started: which, by whom, and its run.
InteractionSwarmAwait	object	A participant waiting on sub-interactions it started.
InteractionSwarmLimits	object	How far a tree of sub-interactions may spread: settled when its root starts, the same for every run in it.
InteractionSwarmLimitsRequest	object	A start’s narrowing of how far the run’s tree of sub-interactions may spread.
InteractionSwarmSettings	object	An interaction’s opt-in to sub-interactions: the interactions its participants may start, which participants may, and how far the work may spread.
InteractionSystemPromptMode	enum	How an interaction’s own system prompts combine with the instructions Maitento gives every agent.
InteractionTokenUsageItem	object	A number of tokens of one kind, the same for every provider.
InteractionVoteNoRequest	object	A person’s vote against what the agents are waiting on: an agent’s vote proposal or its proposed final answer.
InteractionVoteYesRequest	object	A person’s vote for what the agents are waiting on: an agent’s vote proposal or its proposed final answer.
InvitationCode	object	An invitation code: each use sends one invite to register a new tenant, or registers one, until it runs out.
Invite	object	An invitation sent by e-mail, either to join a tenant or to register a new one.
InviteEmailResponse	object	The result of re-sending an invite’s e-mail.
InviteStatus	enum	Where an invite stands.
InviteSummary	object	What an invite is for, shown to the person accepting it before they register.
LaneAddOnPrice	object	The price of one extra concurrency lane on a tier.
LaneAddOnQuantity	object	How many extra lanes of one type a tenant has bought.
LaneAllowance	object	A tier’s concurrency for one lane type: how many runs it includes, and the most it can grow to with bought lanes.
LaneType	enum	The kinds of concurrency lane.
LaneWaitReason	enum	Why a run is waiting for a lane.
Loom	object	A loom: an agent’s long-term memory.
LoomConfiguration	object	Long-term memory for an interaction’s agents (`loom = { …
LoomCreateRequest	object	Creates a loom in a namespace.
LoomInspection	object	The state of a loom: its shape, what is held close, what is fading, and what the night last did.
LoomMapping	object	The loom one agent of a run wakes up with.
LoomMappingRequest	object	The loom one agent wakes up with in this run, in place of the one the interaction would choose.
LoomPattern	object	The pattern of a codebase: its feel rather than its facts.
LoomRecallMode	enum	How remembered threads come back into a conversation when a new message touches them.
LoomReflection	object	Everything the loom holds about a topic, arranged so the agent can see the whole and synthesise it itself: foundations, what was woven across them, where threads pull against each other, what was let go, and how understanding has shifted.
LoomReflectRequest	object	Asks for everything a loom holds about a topic.
LoomScope	enum	Whose loom an agent wakes up with, and so whether it remembers beyond one run.
LoomSeeding	object	What seeding a loom from another did.
LoomSeedRequest	object	Seeds a loom from another loom of your tenant.
LoomSession	object	One agent’s time with a loom in one interaction run: what it woke up knowing, what it was shown, what it recalled and wove.
LoomSettings	object	A loom’s settings: whether night weaving runs, how long it waits for quiet, and which model it uses.
LoomStartGift	object	Threads handed to one agent when its run started (see LoomStartGiftRequest).
LoomStartGiftRequest	object	Threads handed to one agent of an interaction as its run starts, such as the context an agent passes to a helper it starts.
LoomTally	object	The shape of a loom at a glance: how many threads it holds, and of what sort.
LoomTension	object	Two threads in tension: they contradict each other, one appears to replace the other, or they hold different perspectives.
LoomTensionView	object	A tension with the two threads it joins.
LoomThread	object	A thread: one memory.
LoomUpdateRequest	object	Changes a loom’s name, description or settings.
LoomWeaveMode	enum	How new threads come to be woven from a conversation.
LostPasswordInitiateRequest	object	Asks for a password-reset e-mail.
LowBalanceAlertSettings	object	The low-balance warnings a tenant has chosen.
MaitentoValidationResult	object	One reason a request was refused with a 400.
ManagedAgentMode	enum	What a managed interaction’s agent sees when its manager dispatches work to it.
ManagedInteraction	object	A managed interaction: a manager agent runs the conversation and hands work to the other agents, each of which sees only what its mode allows.
ManagedInteractionAgentBinding	object	An agent a managed interaction’s manager can dispatch work to, and what it sees when it does.
ManagedInteractionCreateRequest	object	Creates a managed interaction: a manager agent and the agents it can hand work to.
ManagedInteractionUpdateRequest	object	A new version of a managed interaction: a manager agent and the agents it can hand work to.
ManagedInteractionVersion	object	A version of a managed interaction: a manager agent and the agents it can dispatch work to.
McpConnector	object	A connector to a tool on an MCP (Model Context Protocol) server.
McpConnectorCreateRequest	object	Creates a connector to a tool on an MCP (Model Context Protocol) server.
McpConnectorVersion	object	One version of an MCP connector.
McpExternalOperation	object	A tool that calls an MCP connector.
McpExternalOperationBinding	object	An MCP tool made available in one place (to a whole interaction, to one participant, or to an app), with any values and credentials that apply there.
McpExternalOperationCreateRequest	object	Creates a tool that calls an MCP connector.
McpExternalOperationVersion	object	One version of an MCP tool.
MessageTrigger	object	A trigger that starts an automation when another run changes and matches a filter.
MessageTriggerType	enum	Which kind of run’s changes a message trigger listens to.
MeterAllowances	object	What a tier includes each month on the consumable meters, each in that meter’s base unit.
MeterRates	object	A price book’s list rates, in the price book’s currency.
ModelCredential	object	A tenant’s own credential for a model provider (collection modelCredential).
ModelCredentialKey	object	One API key of a credential.
ModelCredentialKeyRequest	object	One key on a credential request: an existing key by ModelCredentialKeyRequest.Id, a new key by ModelCredentialKeyRequest.Value, or a replacement with both.
ModelCredentialOAuth	object	A coding agent’s subscription sign-in held by an OAuth credential (CredentialKind.OAuth): Claude Code’s or Codex’s.
ModelCredentialRequest	object	A credential to create, or what an existing one should become.
ModelKeyProvider	enum	The model vendor a model key authenticates with, such as "provider": "DeepSeek".
Namespace	object	A folder for definitions: agents, interactions, apps and the rest are deployed into a namespace.
NamespaceCreateOrUpdateRequest	object	Creates a namespace, or renames one.
NameValuePair	object	A named text value, such as one input of a run.
NightWeaving	object	One night’s weaving of a loom: consolidation that runs in the background once its conversations go quiet.
NightWeavingCounts	object	What one night’s weaving did.
NightWeavingStatus	enum	Where a night weaving is.
OneShotInteraction	object	A one-shot interaction: one agent takes the task and gives its answer.
OneShotInteractionCreateRequest	object	Creates a one-shot interaction: one agent takes the task and gives its answer.
OneShotInteractionUpdateRequest	object	A new version of a one-shot interaction.
OneShotInteractionVersion	object	A version of a one-shot interaction.
OpenApiConnector	object	A connector to one HTTP endpoint: its method, URL, parameters and request and response schemas.
OpenApiConnectorCreateRequest	object	Creates a connector to one HTTP endpoint.
OpenApiConnectorVersion	object	One version of an HTTP (OpenAPI) connector.
OpenApiExternalOperation	object	A tool that calls an HTTP (OpenAPI) connector.
OpenApiExternalOperationBinding	object	An HTTP tool made available in one place (to a whole interaction, to one participant, or to an app), with any values and credentials that apply there.
OpenApiExternalOperationCreateRequest	object	Creates a tool that calls an HTTP (OpenAPI) connector.
OpenApiExternalOperationVersion	object	One version of an HTTP tool.
OpenApiParameter	object	A path or query parameter of an HTTP connector.
OpenApiParameterDataType	enum	The type of value a connector parameter takes.
Partition	object	A partition: a knowledge base.
PartitionCreateRequest	object	Creates a partition (a knowledge base), or a temporary partition for short-lived files.
PartitionEmbeddingCredential	object	One of your own provider API keys that a partition’s embeddings may authenticate with, in the partition’s ordered list of keys.
PartitionEmbeddingCredentialFailure	object	A failure recorded against one of a partition’s embedding keys.
PartitionEmbeddingCredentialsRequest	object	Sets a partition’s embedding keys and its consent to fall back to Maitento’s key, replacing whatever was there.
PartitionEmbeddingCredentialStackRequest	object	Sets the credential stack a partition embeds with, in place of the tenant’s model keys and default stack.
PartitionEmbeddingIndexState	object	Progress of a partition’s re-index: after its embedding profile changes, every file is embedded again with the new model.
PartitionEmbeddingIndexStatus	enum	Where a partition’s embedding index is: ready, being rebuilt, or stopped on a failure.
PartitionEmbeddingProbeRequest	object	A test call: embeds one short text with profile using credentials, and reports what came back.
PartitionEmbeddingProbeResult	object	What a test call (PartitionEmbeddingProbeRequest) found.
PartitionEmbeddingProfile	object	Which embedding model a partition’s files are indexed with, at what width, and how they are cut into chunks first.
PartitionEmbeddingProfileRequest	object	Sets a partition’s embedding profile together with its keys and fallback consent, in one change, so the keys always match the profile’s provider.
PartitionEmbeddingStatus	object	A partition’s embedding settings as they apply, with every default filled in, and the state of its index: which model it is indexed with, and whether search is available.
PartitionEmbeddingStatusRequest	object	Asks for the embedding status of up to 500 partitions in one call.
PasswordResetRequest	object	Sets a new password with the key from a password-reset e-mail.
PatternChange	object	A change to a codebase’s pattern.
PendingToolCallApproval	object	A tool call waiting for a person’s approval before it runs.
PendingToolCallApprovalStatus	enum	Where a tool call waiting for approval has got to.
ProcessDashboard	object	The overview dashboard (GET /processes/summary).
ProcessListRequest	object	The query string of GET /processes.
ProcessPage	object	One page of GET /processes, newest first.
ProcessRetentionLease	object	A retention lease: it keeps a run (and every run it started) from being deleted when its retention period ends, until it is released.
ProcessRetentionLeaseRequest	object	PUT /processes/{processType}/{processId}/retention-lease: retain a run.
ProcessRetentionSource	enum	Where the retention period that applies to a run comes from.
ProcessRetentionStatus	object	How long one run will be kept, and why: GET|PUT|DELETE /processes/{processType}/{processId}/retention-lease.
ProcessStartConfig	shapes	What an automation action does, chosen by $type (which must come first): app, interaction, interaction-message, capsule or codepipeline.
ProcessState	enum	The group a run’s status falls into, the same for all four kinds of run, so one filter (“show me what is waiting on a person”) works across them even though each kind names its statuses differently.
ProcessSummary	object	One row of the runs listing (GET /processes): the same shape for all four kinds of run.
ProcessThroughputPoint	object	One hour of one kind of run on the throughput chart.
ProcessTokenPoint	object	Token usage across all runs for one hour.
ProcessTokenTotals	object	A run’s token usage, totalled into five kinds.
ProcessType	enum	The kind of a run.
ProcessTypeStateCounts	object	Run counts for one kind of run on the overview dashboard.
ProcessUpdatedSummary	object	What the tenant-wide process-updated event carries: a short summary of any run in the tenant that changed, the same shape for all four kinds of run.
PromptInput	object	An input a run is started with, filled into the interaction’s prompt wherever it says %%name%%.
ProposedThread	object	A thread the loom thinks may be worth keeping, offered to the agent to weave if it agrees.
QueuePriorityClass	enum	Where a tenant’s work waits relative to others when runners are scarce.
ResendEmailAddressVerificationEmailRequest	object
ResourceFileReference	object	A shared prompt or JSON file of a project, which other files read by name.
ResourceFileReferences	object	The shared prompts and JSON files of a project, sent with a build.
RoundRobinInteraction	object	A round-robin interaction: agents, and optionally a person, take turns in one shared conversation.
RoundRobinInteractionCreateRequest	object	Creates a round-robin interaction: agents, and optionally a person, take turns in one conversation.
RoundRobinInteractionHumanSettings	object	How a person takes part in an interaction’s conversation.
RoundRobinInteractionUpdateRequest	object	A new version of a round-robin interaction.
RoundRobinInteractionVersion	object	A version of a round-robin interaction.
RunLaneWait	object	Whether a run is waiting for a lane before it starts, and why.
ScheduledContractChangeKind	enum	Why a contract change waits for the renewal.
Secret	object	A secret value, such as an API key for a tool to send, stored for the tenant.
SecretCreateRequest	object	Stores a new secret.
SecretUpdateRequest	object	Renames a secret, replaces its value, or both.
SendInviteRequest	object	Invites someone by e-mail, either into the caller’s tenant or to register a tenant of their own.
SendInviteResponse	object	The invite just created, and whether its e-mail went out.
SkuDefinition	object	Everything a tier gives a tenant apart from its prices: allowances, caps, concurrency, retention, discount, priority and capabilities.
SkuTier	enum	The plans.
SsoConfirmLinkRequest	object	Confirms linking an identity to an account, with the link from the confirmation e-mail.
SsoExchangeRequest	object	Redeems the one-time code a sign-in with an identity provider came back with.
SsoProvider	enum	An identity provider a person can sign in to Maitento with.
SsoProvidersResponse	object	The identity providers people can sign in with, and whether someone without an account can sign up.
TapestryPanel	object	One panel of the tapestry: short prose, woven during night weaving, about one subject.
TapestryPreview	object	What an agent would wake up knowing if these subjects walked in now: the “What You Know” that would be woven into its instructions, made without starting a session or changing any thread.
TenantBalance	object	A tenant’s prepaid balance, as shown to the tenant.
TenantModelAccess	object	Whether the tenant’s runs may use Maitento’s own provider keys, and whether the tenant has model keys of its own.
TenantModelKey	object	One of the tenant’s own provider API keys (“bring your own key”), used when a run calls that provider’s models and the run was not started with a key of its own.
TenantModelKeyCreateRequest	object	Stores one of the tenant’s own provider keys.
TenantModelKeyUpdateRequest	object	Replaces a model key’s settings.
TenantRegisterRequest	object	Registers a new tenant and its first user: with an invitation code, or, where sign-up is open, without one.
TenantRegisterResponse	object	The tenant and user a registration created.
TenantRetention	object	A tenant’s run retention: how long a run that has ended is kept before Maitento deletes it, where that period comes from, and how many runs the tenant is keeping with retention leases.
TenantRetentionRequest	object	PUT /tenants/self/retention: set or clear the tenant’s own run retention.
TenantRetentionSource	enum	Where a tenant’s run retention comes from.
TensionKind	enum	How two threads pull against each other.
TensionResolveRequest	object	Resolves an open tension between two threads.
ThreadBasis	enum	What a thread rests on.
ThreadCompanion	object	A thread this one has been used together with, and in how many sessions.
ThreadCutRequest	object	Cuts a thread: its words are released and a knot remains, with why it was let go.
ThreadGiveRequest	object	Gives a thread to another loom of your tenant.
ThreadKind	enum	What kind of memory a thread is.
ThreadKnot	object	Cut thread, knot remains.
ThreadKnotFilter	enum	Whether a thread listing shows cut threads (knots).
ThreadListOrder	enum	How a thread listing is ordered.
ThreadOrigin	object	Lineage: who wove (or cut, or reframed) a thread, and from where.
ThreadOriginKind	enum	Who or what wove, cut or reframed a thread.
ThreadPinRequest	object	Pins or releases a thread.
ThreadProvenance	object	Where a thread came from when it was not woven in this loom: given by another agent, or inherited when the loom was seeded from another.
ThreadProvenanceKind	enum	How a thread came from another loom.
ThreadRecallRequest	object	Searches a loom’s threads by meaning and by words, the way an agent recalls.
ThreadRecollection	object	A thread a recall found, with why it ranked where it did.
ThreadReframeRequest	object	A revision to a thread.
ThreadSeam	object	The visible seam a reframe leaves: what the thread said before, and why it changed, so you can trace how understanding moved.
ThreadStrand	enum	Whether a thread is foundational (warp) or contextual (weft).
ThreadVisibility	enum	Which agents bound to a loom may see a thread.
ThreadWeaveRequest	object	A thread to weave.
ToolResultTrimmingMode	enum	When the results of earlier tool calls are replaced, to save space in the conversation.
ToolResultTrimmingStyle	enum	What a trimmed tool result becomes.
TreeEntry	object	A flat entry in the tree (alternative to nested structure).
TreeNode	object	A node in the tree structure.
TreeRequest	object	Request for recursive directory listing.
TreeResponse	object	A directory tree: nested from root, and as a flat list in entries.
TriggerResponse	object	The result of running an automation by hand.
UpdateAutomatedActionRequest	object	Changes an automation’s name, description and actions.
UsageBreakdown	object	A range’s usage grouped by one dimension, such as by namespace or by model.
UsageBreakdownRequest	object	What to group a usage breakdown by, how to order it, and the usual usage filters.
UsageBreakdownRow	object	One group of a UsageBreakdown.
UsageOutcome	enum	How a run ended, or that it had not ended when its usage was recorded.
UsageOutcomeTotals	object	The usage of the runs that ended one way (or are still in progress).
UsageQueryRequest	object	The time range and filters every /usage call takes.
UsageRunPage	object	The individual runs behind a range’s usage, largest first by the chosen measure.
UsageRunRow	object	One run behind a range’s usage.
UsageRunsRequest	object	How to order the runs behind a range’s usage, how many to return, and the usual usage filters.
UsageSeries	object	One measure over time, in UTC buckets, optionally split by a dimension into the largest groups and one “other” series.
UsageSeriesLine	object	One series of a UsageSeries.
UsageSeriesRequest	object	Which measure to chart, in what buckets, split how, and the usual usage filters.
UsageStartedBy	enum	What started a run.
UsageSummary	object	A range’s usage totals, the totals for the same-length range before it, and the split by how runs ended.
UsageTokenTotals	object	Tokens by type.
UsageTotals	object	Usage over a range.
User	object	A person who can sign in to a tenant.
UserApiCreateResponse	object	A new API key.
UserApiKey	object	One of the calling user’s API keys.
UserApiKeyCreateRequest	object	Creates an API key for the calling user.
UserRegisterRequest	object	Registers a user in an existing tenant by accepting an invite to it.
UserUpdateRequest	object	Changes another user of the tenant: their role and whether they may sign in.
UserVerifyEmailAddressRequest	object	Verifies a user’s e-mail address with the key from the verification e-mail.
ValidationResponse	object	The body of a 400: every reason the request was refused.
VersionReference	object	A pointer to one exact version of a definition: its id and version number.
VirtualFileSystem	object	A virtual file system (VFS): a named folder tree in a namespace.
VirtualFileSystemCreateRequest	object	Creates a file system.
VirtualFileSystemMount	object	A run a file system is mounted into.
VirtualFileSystemMountType	enum	The kind of run a file system is mounted into.
VirtualFileSystemStatus	enum	Where a file system is in its life.
WeaveResult	object	The thread that now holds what was woven, and whether it was new or an existing thread strengthened.
WebAccessOverride	object	A run’s override of one agent’s web tools (or every agent’s, when agentName is null): each member true (on), false (off) or null (as the interaction and agent decide).
WebAccessSettings	object	A tenant’s or a namespace’s web-tool settings (/tenants/self/web-access, /namespaces/by-id/{id}/web-access): the temporary partition runs’ web fetches go to when their start names none.
WebContentKind	enum	What a fetched URL turned out to be, which decides how it was turned into text.
WebFetchRoute	enum	How fetched content was obtained.
WebFetchUnitTable	object	How many fetch units each kind of web fetch counts as, against the allowance and the per-unit rate.
WebHookDelivery	object	One delivery of a web hook: a call Maitento has made, or will make, to the registration’s URL.
WebHookRegistration	object	A web hook: a URL Maitento calls whenever something of one type changes, such as an interaction run or an uploaded file.
WebHookRegistrationCreateRequest	object	Registers a web hook.
WebHookRegistrationUpdateRequest	object	Changes a web hook’s URL, secret or headers.
WebHookType	enum	What a web hook reports on: each change to one kind of run, or to uploaded files.
WebProxyTier	enum	The scraping provider’s proxy pools, cheapest first.
WebUsageKind	enum	What one metered web call (WebUsageRecord) paid for.
WebUsageRecord	object	One metered call an agent’s web tools made: a page of search results, a page read, a direct download, or an image description.