Files

5871 lines
142 KiB
YAML

components:
schemas:
AnswerInputBody:
additionalProperties: false
properties:
approved:
type: boolean
required:
- approved
type: object
ApprovalsView:
additionalProperties: false
properties:
action:
type: string
answered_at:
format: date-time
type: string
answered_by:
type: string
answered_via:
type: string
deadline:
format: date-time
type: string
decision_id:
type: string
id:
type: string
kind:
type: string
level:
type: string
requested_at:
format: date-time
type: string
run_id:
type: string
state:
type: string
step:
format: int64
type: integer
step_deadline:
format: date-time
type: string
summary:
type: string
target:
type: string
required:
- id
- kind
- run_id
- action
- target
- level
- summary
- state
- deadline
- step
- decision_id
- requested_at
type: object
AuditjsonPayload:
additionalProperties: false
properties:
json: {}
length:
format: int64
type: integer
sha256:
type: string
text:
type: string
truncated:
type: boolean
type: object
AuthenticationInputBody:
additionalProperties: false
properties:
oidc_audience:
type: string
oidc_client_id:
type: string
oidc_issuer:
type: string
public_url:
type: string
required:
- public_url
type: object
ChangePasswordInputBody:
additionalProperties: false
properties:
current_password:
type: string
new_password:
type: string
required:
- current_password
- new_password
type: object
ChatActionDone:
additionalProperties: false
properties:
request_id:
type: string
result:
type: string
state:
type: string
required:
- request_id
- state
type: object
ChatApproval:
additionalProperties: false
properties:
action:
type: string
deadline:
format: date-time
type: string
level:
type: string
request_id:
type: string
summary:
type: string
required:
- request_id
- action
- summary
- level
- deadline
type: object
ChatNavigation:
additionalProperties: false
properties:
label:
type: string
path:
type: string
required:
- path
- label
type: object
ChatSession:
additionalProperties: false
properties:
created_at:
format: date-time
type: string
session_id:
type: string
title:
type: string
updated_at:
format: date-time
type: string
required:
- session_id
- title
- created_at
- updated_at
type: object
ChatSessions:
additionalProperties: false
properties:
active_model:
type: string
model_error:
type: string
sessions:
items:
$ref: "#/components/schemas/ChatSession"
type:
- array
- "null"
required:
- sessions
- active_model
type: object
ChatToolCall:
additionalProperties: false
properties:
duration_ms:
format: int64
type: integer
failed:
type: boolean
id:
type: string
name:
type: string
parameters:
type: string
text:
type: string
text_offset:
format: int64
type: integer
required:
- id
- name
- parameters
- text
- duration_ms
- text_offset
type: object
ChatTurn:
additionalProperties: false
properties:
actions:
items:
$ref: "#/components/schemas/ChatActionDone"
type:
- array
- "null"
approvals:
items:
$ref: "#/components/schemas/ChatApproval"
type:
- array
- "null"
created_at:
format: date-time
type: string
error:
type: string
finished_at:
format: date-time
type:
- string
- "null"
id:
type: string
navigate:
items:
$ref: "#/components/schemas/ChatNavigation"
type:
- array
- "null"
page:
type: string
page_label:
type: string
reasoning:
type: string
reply:
type: string
seq:
format: int64
type: integer
session_id:
type: string
state:
type: string
text:
type: string
tool_calls:
items:
$ref: "#/components/schemas/ChatToolCall"
type:
- array
- "null"
required:
- id
- session_id
- seq
- state
- text
- reply
- tool_calls
- approvals
- actions
- navigate
- created_at
type: object
ConnectorsAcceptRequest:
additionalProperties: false
properties:
credentials:
additionalProperties:
type: string
type: object
egress:
description: Every host the extension may reach
items:
type: string
type:
- array
- "null"
env:
description: Host environment variables the extension may see
items:
type: string
type:
- array
- "null"
path:
description: The extension binary on the host
type: string
settings:
additionalProperties:
type: string
type: object
sha256:
description: The binary's digest; it runs only while the digest matches
type: string
required:
- path
- sha256
type: object
ConnectorsCall:
additionalProperties: false
properties:
connector:
type: string
error:
type: string
method:
type: string
request:
$ref: "#/components/schemas/AuditjsonPayload"
response:
$ref: "#/components/schemas/AuditjsonPayload"
required:
- connector
- method
- request
type: object
ConnectorsCredentialKind:
additionalProperties: false
properties:
kind:
type: string
optional:
items:
type: string
type:
- array
- "null"
required:
items:
type: string
type:
- array
- "null"
required:
- kind
- required
type: object
ConnectorsCredentialRequest:
additionalProperties: false
properties:
fields:
additionalProperties:
$ref: "#/components/schemas/ConnectorsField"
type: object
kind:
type: string
required:
- kind
- fields
type: object
ConnectorsCredentialSaved:
additionalProperties: false
properties:
kind:
type: string
name:
type: string
restarted:
items:
type: string
type:
- array
- "null"
required:
- name
- kind
- restarted
type: object
ConnectorsCredentialView:
additionalProperties: false
properties:
fields:
additionalProperties:
type: string
type: object
kind:
type: string
name:
type: string
required:
- name
- kind
- fields
type: object
ConnectorsEffect:
additionalProperties: false
properties:
ReadOnly:
type: boolean
Reversibility:
format: int64
type: integer
Summary:
type: string
required:
- ReadOnly
- Reversibility
- Summary
type: object
ConnectorsExtensionKind:
additionalProperties: false
properties:
group:
enum:
- platform
- integration
- agent
type: string
kind:
description: The API path segment that lists this kind
type: string
label:
type: string
singular:
type: string
required:
- kind
- label
- singular
- group
type: object
ConnectorsExtensionView:
additionalProperties: false
properties:
args:
items:
type: string
type:
- array
- "null"
contract:
type: string
credentials:
additionalProperties:
type: string
type: object
digest:
type: string
egress:
items:
type: string
type:
- array
- "null"
env:
items:
type: string
type:
- array
- "null"
error:
type: string
group:
enum:
- platform
- integration
- agent
type: string
name:
type: string
path:
type: string
settings:
additionalProperties:
type: string
type: object
settings_schema:
items:
$ref: "#/components/schemas/ConnectorsSetting"
type:
- array
- "null"
state:
type: string
tools: {}
url:
type: string
version:
type: string
required:
- name
- contract
- group
- state
- digest
- egress
- env
- settings
- settings_schema
- credentials
type: object
ConnectorsField:
additionalProperties: false
properties:
engine:
type: string
key:
type: string
value:
type: string
writeOnly: true
type: object
ConnectorsMcpRequest:
additionalProperties: false
properties:
args:
items:
type: string
type:
- array
- "null"
credentials:
additionalProperties:
type: string
type: object
egress:
items:
type: string
type:
- array
- "null"
env:
items:
type: string
type:
- array
- "null"
path:
type: string
settings:
additionalProperties:
type: string
type: object
sha256:
type: string
tools:
items:
$ref: "#/components/schemas/ConnectorsToolDecl"
type:
- array
- "null"
url:
type: string
type: object
ConnectorsPackageState:
additionalProperties: false
properties:
name:
type: string
state:
enum:
- running
- removed
type: string
required:
- name
- state
type: object
ConnectorsSetting:
additionalProperties: false
properties:
description:
type: string
key:
type: string
label:
type: string
options:
items:
type: string
type:
- array
- "null"
required:
type: boolean
secret:
type: boolean
type:
type: string
required:
- key
- label
type: object
ConnectorsTarget:
additionalProperties: false
properties:
Disposable:
type: boolean
Environment:
type: string
ID:
type: string
Kind:
type: string
required:
- Kind
- ID
- Environment
- Disposable
type: object
ConnectorsToolDecl:
additionalProperties: false
properties:
kind:
type: string
name:
type: string
read_only:
type: boolean
reversibility:
type: string
summary:
type: string
required:
- name
- kind
type: object
CorrectInputBody:
additionalProperties: false
properties:
text:
description: The corrected note
type: string
required:
- text
type: object
CreateTokenInputBody:
additionalProperties: false
properties:
days:
format: int64
type: integer
name:
type: string
required:
- name
type: object
CreateWorkspaceInputBody:
additionalProperties: false
properties:
environment:
description: Free-form attribute policies can test
type: string
id:
description: Workspace ID, permanent for the workspace's life
type: string
name:
description: Display name
type: string
required:
- id
- name
type: object
DeliveriesAttempt:
additionalProperties: false
properties:
at:
format: date-time
type: string
attempt:
format: int64
type: integer
channel:
type: string
duration_ms:
format: int64
type: integer
error:
type: string
ok:
type: boolean
response:
type: string
required:
- channel
- attempt
- at
- ok
- duration_ms
type: object
DeliveriesMessage:
additionalProperties: false
properties:
attempts:
items:
$ref: "#/components/schemas/DeliveriesAttempt"
type:
- array
- "null"
body:
type: string
created_at:
format: date-time
type: string
expires_at:
format: date-time
type:
- string
- "null"
id:
type: string
kind:
type: string
request_id:
type: string
run_id:
type: string
seq:
format: int64
type: integer
title:
type: string
required:
- seq
- id
- kind
- title
- body
- created_at
type: object
DisabledInputBody:
additionalProperties: false
properties:
disabled:
description: Whether the note stops being read
type: boolean
required:
- disabled
type: object
DraftsTrigger:
additionalProperties: false
properties:
event_type:
type: string
filter: {}
source:
type: string
required:
- source
- event_type
- filter
type: object
DraftsView:
additionalProperties: false
properties:
dry_event_id:
type: string
dry_run:
$ref: "#/components/schemas/RunsDryReport"
group_id:
type: string
id:
type: string
name:
type: string
policy:
type: string
policy_kind:
type: string
published_at:
format: date-time
type:
- string
- "null"
summary:
type: string
trigger:
$ref: "#/components/schemas/DraftsTrigger"
workflow:
type: string
required:
- id
- group_id
- name
- trigger
- workflow
- policy_kind
- policy
- summary
type: object
DryRunInputBody:
additionalProperties: false
properties:
event_id:
description: The stored event to replay; the newest by default
type: string
type: object
EditInputBody:
additionalProperties: false
properties:
name:
type: string
policy:
description: Cedar policy text added when the draft is published
type: string
policy_kind:
enum:
- hard_rules
- change_request
type: string
workflow:
description: The workflow document
type: string
required:
- name
- workflow
- policy_kind
type: object
ErrorDetail:
additionalProperties: false
properties:
location:
description: Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
type: string
message:
description: Error message text
type: string
value:
description: The value at the given location
type: object
ErrorModel:
additionalProperties: false
properties:
detail:
description: A human-readable explanation specific to this occurrence of the problem.
examples:
- Property foo is required but is missing.
type: string
errors:
description: Optional list of individual error details
items:
$ref: "#/components/schemas/ErrorDetail"
type:
- array
- "null"
instance:
description: A URI reference that identifies the specific occurrence of the problem.
examples:
- https://example.com/error-log/abc123
format: uri
type: string
status:
description: HTTP status code
examples:
- 400
format: int64
type: integer
title:
description: A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
examples:
- Bad Request
type: string
type:
default: about:blank
description: A URI reference to human-readable documentation for the error.
examples:
- https://example.com/errors/example
format: uri
type: string
type: object
EventsEventDetail:
additionalProperties: false
properties:
body: {}
runs:
items:
$ref: "#/components/schemas/EventsTriggerRun"
type:
- array
- "null"
required:
- body
- runs
type: object
EventsEventView:
additionalProperties: false
properties:
dispatched_at:
format: date-time
type: string
fields: {}
id:
type: string
linked_to:
type: string
matched:
type: boolean
occurred_at:
format: date-time
type: string
received_at:
format: date-time
type: string
source:
type: string
type:
type: string
required:
- id
- source
- type
- fields
- received_at
- matched
type: object
EventsGroupView:
additionalProperties: false
properties:
count:
format: int64
type: integer
first_seen:
format: date-time
type: string
id:
type: string
last_seen:
format: date-time
type: string
proposed:
$ref: "#/components/schemas/EventsProposedTrigger"
required:
- id
- count
- first_seen
- last_seen
- proposed
type: object
EventsKeyFieldsSaved:
additionalProperties: false
properties:
key_fields:
items:
type: string
type:
- array
- "null"
required:
- key_fields
type: object
EventsProposedTrigger:
additionalProperties: false
properties:
event_type:
type: string
filter: {}
source:
type: string
workflow:
type: string
required:
- source
- event_type
- filter
- workflow
type: object
EventsSourceCreated:
additionalProperties: false
properties:
source:
type: string
token:
description: Returned once for a token source; only its hash is stored
type: string
url:
description: Where the sender posts its events
type: string
required:
- source
- url
type: object
EventsSourceView:
additionalProperties: false
properties:
connector:
type: string
hmac_header:
type: string
hmac_prefix:
type: string
hmac_secret_set:
type: boolean
key_fields:
items:
type: string
type:
- array
- "null"
name:
type: string
token_set:
type: boolean
verification:
type: string
required:
- name
- connector
- key_fields
- token_set
- verification
- hmac_secret_set
type: object
EventsTriggerRun:
additionalProperties: false
properties:
run_id:
type: string
trigger:
type: string
required:
- trigger
- run_id
type: object
EventsTriggerSaved:
additionalProperties: false
properties:
trigger:
type: string
required:
- trigger
type: object
EventsTriggerView:
additionalProperties: false
properties:
enabled:
type: boolean
event_type:
type: string
every:
type: string
filter:
additionalProperties:
type: string
type: object
name:
type: string
source:
type: string
workflow:
type: string
required:
- name
- source
- event_type
- filter
- workflow
- enabled
type: object
GovernanceAuthStatusBody:
additionalProperties: false
properties:
instance:
type: string
oidc:
type: boolean
public_url:
type: string
setup_required:
type: boolean
user:
$ref: "#/components/schemas/GovernanceIdentity"
required:
- setup_required
- user
- oidc
- public_url
- instance
type: object
GovernanceAuthenticationSettings:
additionalProperties: false
properties:
oidc_audience:
type: string
oidc_client_id:
type: string
oidc_issuer:
type: string
public_url:
type: string
required:
- public_url
- oidc_issuer
- oidc_audience
- oidc_client_id
type: object
GovernanceBlackout:
additionalProperties: false
properties:
from:
format: date-time
type: string
reason:
type: string
to:
format: date-time
type: string
required:
- from
- to
- reason
type: object
GovernanceCapabilitiesBody:
additionalProperties: false
properties:
sections:
additionalProperties:
type: boolean
type: object
required:
- sections
type: object
GovernanceCreatedToken:
additionalProperties: false
properties:
id:
type: string
token:
type: string
required:
- id
- token
type: object
GovernanceIdentity:
additionalProperties: false
properties:
created_at:
format: date-time
type: string
display_name:
type: string
id:
type: string
kind:
type: string
lifecycle:
type: string
updated_at:
format: date-time
type: string
version:
format: int64
type: integer
required:
- id
- kind
- display_name
- lifecycle
- version
- created_at
- updated_at
type: object
GovernanceModel:
additionalProperties: false
properties:
api_key_credential:
type: string
base_url:
type: string
class:
type: string
model:
type: string
required:
- class
- base_url
- model
type: object
GovernanceModelAnswer:
additionalProperties: false
properties:
answer:
type: string
model:
type: string
required:
- model
- answer
type: object
GovernanceOrgBody:
additionalProperties: false
properties:
org:
$ref: "#/components/schemas/GovernanceOrgView"
required:
- org
type: object
GovernanceOrgEvent:
additionalProperties: false
properties:
actor_id:
type: string
actor_name:
type: string
at:
format: date-time
type: string
id:
format: int64
type: integer
kind:
type: string
new_name:
type: string
old_name:
type: string
workspace_id:
type: string
required:
- id
- kind
- actor_id
- actor_name
- old_name
- new_name
- at
type: object
GovernanceOrgEventsBody:
additionalProperties: false
properties:
events:
items:
$ref: "#/components/schemas/GovernanceOrgEvent"
type:
- array
- "null"
required:
- events
type: object
GovernanceOrgView:
additionalProperties: false
properties:
id:
type: string
name:
type: string
role:
type: string
version:
format: int64
type: integer
required:
- id
- name
- version
type: object
GovernanceOrgsBody:
additionalProperties: false
properties:
current:
type: string
instance_admin:
type: boolean
member_orgs:
items:
type: string
type:
- array
- "null"
orgs:
items:
$ref: "#/components/schemas/GovernanceOrgView"
type:
- array
- "null"
required:
- orgs
- current
- instance_admin
- member_orgs
type: object
GovernancePasskey:
additionalProperties: false
properties:
id:
type: string
name:
type: string
required:
- id
- name
type: object
GovernancePasskeyFinishBody:
additionalProperties: false
properties:
credential: {}
name:
type: string
required:
- credential
type: object
GovernancePasskeysBody:
additionalProperties: false
properties:
passkeys:
items:
$ref: "#/components/schemas/GovernancePasskey"
type:
- array
- "null"
required:
- passkeys
type: object
GovernancePersonRequest:
additionalProperties: false
properties:
authority:
type: boolean
id:
description: Empty for a new person
type: string
identities:
items:
type: string
type:
- array
- "null"
name:
type: string
required:
- name
- authority
- identities
type: object
GovernancePersonalToken:
additionalProperties: false
properties:
created_at:
format: date-time
type: string
expires_at:
format: date-time
type:
- string
- "null"
id:
type: string
last_used_at:
format: date-time
type:
- string
- "null"
name:
type: string
required:
- id
- name
- created_at
- expires_at
- last_used_at
type: object
GovernanceRegistration:
additionalProperties: false
properties:
display_name:
type: string
email:
type: string
organisation_name:
type: string
password:
type: string
public_url:
type: string
role:
type: string
workspace_name:
type: string
required:
- email
- display_name
- password
type: object
GovernanceSettingsRequest:
additionalProperties: false
properties:
actions_per_day:
format: int64
type: integer
actions_per_run:
format: int64
type: integer
approval_deadline:
type: string
attempts_per_run:
format: int64
type: integer
default_owner:
type: string
escalation:
items:
$ref: "#/components/schemas/GovernanceStepRequest"
type:
- array
- "null"
frozen:
type: boolean
raise_after:
format: int64
type: integer
recurrence_threshold:
format: int64
type: integer
timing:
$ref: "#/components/schemas/GovernanceTiming"
required:
- approval_deadline
- raise_after
- frozen
- recurrence_threshold
- attempts_per_run
- default_owner
- escalation
- timing
- actions_per_run
- actions_per_day
type: object
GovernanceStepRequest:
additionalProperties: false
properties:
deadline:
type: string
person:
type: string
required:
- person
- deadline
type: object
GovernanceTiming:
additionalProperties: false
properties:
blackouts:
items:
$ref: "#/components/schemas/GovernanceBlackout"
type:
- array
- "null"
days:
items:
type: string
type:
- array
- "null"
end:
type: string
start:
type: string
zone:
type: string
required:
- zone
- start
- end
- days
- blackouts
type: object
GovernanceTokensBody:
additionalProperties: false
properties:
available:
type: boolean
tokens:
items:
$ref: "#/components/schemas/GovernancePersonalToken"
type:
- array
- "null"
required:
- tokens
- available
type: object
GovernanceUserBody:
additionalProperties: false
properties:
user:
$ref: "#/components/schemas/GovernanceIdentity"
required:
- user
type: object
GovernanceWorkspace:
additionalProperties: false
properties:
environment:
type: string
id:
type: string
name:
type: string
org_id:
type: string
version:
format: int64
type: integer
required:
- id
- org_id
- name
- version
type: object
GovernanceWorkspaceBody:
additionalProperties: false
properties:
workspace:
$ref: "#/components/schemas/GovernanceWorkspace"
required:
- workspace
type: object
GovernanceWorkspacesBody:
additionalProperties: false
properties:
workspaces:
items:
$ref: "#/components/schemas/GovernanceWorkspace"
type:
- array
- "null"
required:
- workspaces
type: object
JudgementAction:
additionalProperties: false
properties:
connector:
type: string
digest:
type: string
effect:
$ref: "#/components/schemas/ConnectorsEffect"
input: {}
name:
type: string
target:
$ref: "#/components/schemas/ConnectorsTarget"
required:
- connector
- name
- input
- digest
- target
- effect
type: object
JudgementClassDetail:
additionalProperties: false
properties:
action:
type: string
connector:
type: string
count:
format: int64
type: integer
decisions:
format: int64
type: integer
default:
type: string
environment:
type: string
history:
items:
$ref: "#/components/schemas/JudgementHistoryEntry"
type:
- array
- "null"
id:
type: string
last_decided_at:
format: date-time
type:
- string
- "null"
level:
type: string
raises:
items:
$ref: "#/components/schemas/JudgementRaiseView"
type:
- array
- "null"
reset_at:
format: date-time
type:
- string
- "null"
resets:
items:
$ref: "#/components/schemas/JudgementResetView"
type:
- array
- "null"
target_kind:
type: string
tightened_at:
format: date-time
type:
- string
- "null"
tightened_because:
type: string
required:
- history
- resets
- raises
- id
- connector
- action
- target_kind
- environment
- level
- default
- decisions
- count
type: object
JudgementClassView:
additionalProperties: false
properties:
action:
type: string
connector:
type: string
count:
format: int64
type: integer
decisions:
format: int64
type: integer
default:
type: string
environment:
type: string
id:
type: string
last_decided_at:
format: date-time
type:
- string
- "null"
level:
type: string
reset_at:
format: date-time
type:
- string
- "null"
target_kind:
type: string
tightened_at:
format: date-time
type:
- string
- "null"
tightened_because:
type: string
required:
- id
- connector
- action
- target_kind
- environment
- level
- default
- decisions
- count
type: object
JudgementDecision:
additionalProperties: false
properties:
action:
$ref: "#/components/schemas/JudgementAction"
at:
format: date-time
type: string
calls:
items:
$ref: "#/components/schemas/ConnectorsCall"
type:
- array
- "null"
change_request:
type: boolean
change_request_rule:
type: string
dry:
type: boolean
id:
type: string
key:
type: string
level:
type: string
reason:
type: string
refused_by:
type: string
run_id:
type: string
verdicts:
items:
$ref: "#/components/schemas/JudgementVerdict"
type:
- array
- "null"
required:
- id
- run_id
- key
- action
- level
- verdicts
- at
type: object
JudgementFinding:
additionalProperties: false
properties:
evidence:
type: string
strength:
type: string
text:
type: string
required:
- text
type: object
JudgementHistoryEntry:
additionalProperties: false
properties:
answered_by:
type: string
approval:
type: string
at:
format: date-time
type: string
decision_id:
type: string
level:
type: string
refused_by:
type: string
run_id:
type: string
target:
type: string
required:
- decision_id
- run_id
- target
- level
- at
type: object
JudgementJudgeControl:
additionalProperties: false
properties:
advisory:
type: boolean
digest:
type: string
latest:
$ref: "#/components/schemas/JudgementJudgeStanding"
name:
type: string
settings:
additionalProperties:
type: string
type: object
settings_schema:
items:
$ref: "#/components/schemas/ConnectorsSetting"
type:
- array
- "null"
version:
type: string
required:
- name
- advisory
- settings
- settings_schema
type: object
JudgementJudgeRecord:
additionalProperties: false
properties:
advisory_reason:
type: string
answer:
type: string
answers: {}
basis:
type: string
basis_digest:
type: string
confidence:
format: double
type: number
endpoint_path:
type: string
eval_date:
type: string
http_status:
format: int64
type: integer
latency_ms:
format: int64
type: integer
model:
type: string
reason:
type: string
request: {}
response: {}
result_id:
type: string
trusted:
type: boolean
type: object
JudgementJudgeStanding:
additionalProperties: false
properties:
advisory_reason:
type: string
answer:
type: string
at:
format: date-time
type: string
eval_date:
type: string
model:
type: string
trusted:
type: boolean
required:
- trusted
- at
type: object
JudgementPolicySetView:
additionalProperties: false
properties:
body:
type: string
created_at:
format: date-time
type: string
created_by:
type: string
version:
format: int64
type: integer
versions:
items:
$ref: "#/components/schemas/JudgementVersionView"
type:
- array
- "null"
required:
- version
- body
- created_by
- created_at
- versions
type: object
JudgementRaiseEvidence:
additionalProperties: false
properties:
at:
format: date-time
type: string
by:
type: string
decision_id:
type: string
required:
- decision_id
- by
- at
type: object
JudgementRaiseView:
additionalProperties: false
properties:
answered_at:
format: date-time
type:
- string
- "null"
answered_by:
type: string
deadline:
format: date-time
type: string
evidence:
items:
$ref: "#/components/schemas/JudgementRaiseEvidence"
type:
- array
- "null"
from:
type: string
id:
type: string
proposed_at:
format: date-time
type: string
state:
type: string
to:
type: string
required:
- id
- from
- to
- state
- deadline
- proposed_at
- evidence
type: object
JudgementResetView:
additionalProperties: false
properties:
at:
format: date-time
type: string
by:
type: string
from:
type: string
to:
type: string
required:
- from
- to
- by
- at
type: object
JudgementVerdict:
additionalProperties: false
properties:
advisory:
type: boolean
blind_spots:
items:
type: string
type:
- array
- "null"
ceiling:
type: string
digest:
type: string
failed:
type: string
findings:
items:
$ref: "#/components/schemas/JudgementFinding"
type:
- array
- "null"
guard:
type: string
judges:
items:
$ref: "#/components/schemas/JudgementJudgeRecord"
type:
- array
- "null"
owner:
type: string
version:
type: string
required:
- guard
- ceiling
type: object
JudgementVersionView:
additionalProperties: false
properties:
created_at:
format: date-time
type: string
created_by:
type: string
version:
format: int64
type: integer
required:
- version
- created_by
- created_at
type: object
MemoryNote:
additionalProperties: false
properties:
class:
type: string
created_at:
format: date-time
type: string
disabled:
type: boolean
id:
type: string
owner_id:
type: string
purpose:
type: string
scope:
type: string
shared_by:
type: string
state:
type: string
text:
type: string
version:
format: int64
type: integer
required:
- id
- class
- scope
- state
- purpose
- text
- version
- disabled
- created_at
type: object
MemoryNotes:
additionalProperties: false
properties:
notes:
items:
$ref: "#/components/schemas/MemoryNote"
type:
- array
- "null"
required:
- notes
type: object
MemoryVersion:
additionalProperties: false
properties:
published_at:
format: date-time
type: string
publisher_id:
type: string
purpose:
type: string
text:
type: string
version:
format: int64
type: integer
required:
- version
- text
- purpose
- publisher_id
- published_at
type: object
MemoryVersions:
additionalProperties: false
properties:
versions:
items:
$ref: "#/components/schemas/MemoryVersion"
type:
- array
- "null"
required:
- versions
type: object
PolicyInputBody:
additionalProperties: false
properties:
body:
description: The whole policy set, as Cedar
type: string
required:
- body
type: object
PutKeyFieldsInputBody:
additionalProperties: false
properties:
paths:
description: Paths into the event's fields; none uses the connector's default
items:
type: string
type:
- array
- "null"
type: object
PutSourceInputBody:
additionalProperties: false
properties:
connector:
description: The connector that parses this source's events
type: string
hmac_header:
description: The header that carries the signature (hmac only)
type: string
hmac_prefix:
description: Text before the hex digest in the signature header, such as sha256= (hmac only)
examples:
- sha256=
type: string
hmac_secret:
description: "The shared signing secret (hmac only). Write-only: it is sealed and never returned"
type: string
verification:
description: "How deliveries are verified: a bearer token, an HMAC-SHA256 signature of the body, or no verification"
enum:
- token
- hmac
- none
type: string
required:
- connector
type: object
PutTriggerInputBody:
additionalProperties: false
properties:
disabled:
type: boolean
event_type:
description: The event type that fires it; fixed when every is set
type: string
every:
description: Fire on an interval instead of on events, such as 1h
examples:
- 1h
type: string
filter:
additionalProperties:
type: string
description: Event fields that must match exactly
type: object
source:
description: The source whose events fire it; fixed when every is set
type: string
workflow:
description: The workflow each match runs
type: string
required:
- workflow
type: object
PutWorkflowInputBody:
additionalProperties: false
properties:
body:
description: The workflow document, as YAML
type: string
required:
- body
type: object
RecoverInputBody:
additionalProperties: false
properties:
code:
type: string
email:
type: string
password:
type: string
required:
- email
- code
- password
type: object
RecoveryCodeReplyBody:
additionalProperties: false
properties:
code:
type: string
required:
- code
type: object
RenameInputBody:
additionalProperties: false
properties:
expected_version:
description: The version the caller read, so a stale edit is refused
format: int64
type: integer
name:
description: The new display name
type: string
required:
- name
- expected_version
type: object
RenameInputBody1:
additionalProperties: false
properties:
title:
maxLength: 120
type: string
required:
- title
type: object
RenameWorkspaceInputBody:
additionalProperties: false
properties:
expected_version:
description: The version the caller read, so a stale edit is refused
format: int64
type: integer
name:
description: The new display name
type: string
required:
- name
- expected_version
type: object
RetryRunInputBody:
additionalProperties: false
properties:
from:
description: The step to retry from, by id or as the trail names it; by default the step that parked the run
type: string
type: object
RollbackInputBody:
additionalProperties: false
properties:
version:
description: The published version to publish again
format: int64
type: integer
required:
- version
type: object
RunsActionTrail:
additionalProperties: false
properties:
approval:
$ref: "#/components/schemas/ApprovalsView"
decision:
$ref: "#/components/schemas/JudgementDecision"
effect:
$ref: "#/components/schemas/RunsEffect"
rejudged:
$ref: "#/components/schemas/JudgementDecision"
required:
- decision
type: object
RunsDryAction:
additionalProperties: false
properties:
action:
type: string
ask:
items:
type: string
type:
- array
- "null"
level:
type: string
outcome:
type: string
summary:
type: string
target:
type: string
why:
type: string
required:
- action
- target
- level
- outcome
type: object
RunsDryNotice:
additionalProperties: false
properties:
body:
type: string
title:
type: string
required:
- title
- body
type: object
RunsDryReport:
additionalProperties: false
properties:
actions:
items:
$ref: "#/components/schemas/RunsDryAction"
type:
- array
- "null"
at:
format: date-time
type: string
error:
type: string
findings:
type: string
notice:
$ref: "#/components/schemas/RunsDryNotice"
run_id:
type: string
state:
type: string
required:
- run_id
- state
- actions
- at
type: object
RunsEffect:
additionalProperties: false
properties:
at:
format: date-time
type: string
error:
type: string
output:
type: string
state:
type: string
required:
- state
- at
type: object
RunsOrigin:
additionalProperties: false
properties:
event_id:
type: string
fields: {}
filter: {}
received_at:
format: date-time
type: string
source:
type: string
trigger:
type: string
type:
type: string
required:
- event_id
- source
- type
- fields
- received_at
- trigger
- filter
type: object
RunsRunView:
additionalProperties: false
properties:
attempts:
format: int64
type: integer
created_at:
format: date-time
type: string
detail:
type: string
error:
type: string
finished_at:
format: date-time
type:
- string
- "null"
id:
type: string
result: {}
state:
type: string
workflow:
type: string
workflow_version:
format: int64
type: integer
required:
- id
- workflow
- workflow_version
- state
- attempts
- created_at
type: object
RunsStepType:
additionalProperties: false
properties:
name:
type: string
needs_repository:
type: boolean
settings:
$ref: "#/components/schemas/Schema"
title:
type: string
required:
- name
- title
- needs_repository
- settings
type: object
RunsToolCallView:
additionalProperties: false
properties:
input:
type: string
name:
type: string
required:
- name
- input
type: object
RunsTrail:
additionalProperties: false
properties:
actions:
items:
$ref: "#/components/schemas/RunsActionTrail"
type:
- array
- "null"
entries:
items:
$ref: "#/components/schemas/RunsTrailEntry"
type:
- array
- "null"
origin:
$ref: "#/components/schemas/RunsOrigin"
run:
$ref: "#/components/schemas/RunsRunView"
required:
- run
- actions
- entries
type: object
RunsTrailEntry:
additionalProperties: false
properties:
at:
format: date-time
type: string
error:
type: string
finish_reason:
type: string
input:
type: string
kind:
type: string
name:
type: string
output:
type: string
reasoning:
type: string
request: {}
seq:
format: int64
type: integer
text:
type: string
tool_calls:
items:
$ref: "#/components/schemas/RunsToolCallView"
type:
- array
- "null"
unknown:
type: boolean
usage:
$ref: "#/components/schemas/Usage"
value: {}
required:
- seq
- at
- kind
type: object
RunsWorkflowView:
additionalProperties: false
properties:
body:
type: string
created_at:
format: date-time
type: string
created_by:
type: string
name:
type: string
steps:
items:
type: string
type:
- array
- "null"
version:
format: int64
type: integer
required:
- name
- version
- body
- created_by
- created_at
- steps
type: object
Schema:
additionalProperties: false
properties:
$anchor:
type: string
$comment:
type: string
$defs:
additionalProperties:
$ref: "#/components/schemas/Schema"
type: object
$dynamicAnchor:
type: string
$dynamicRef:
type: string
$id:
type: string
$ref:
type: string
$schema:
type: string
$vocabulary:
additionalProperties:
type: boolean
type: object
additionalItems:
$ref: "#/components/schemas/Schema"
additionalProperties:
$ref: "#/components/schemas/Schema"
allOf:
items:
$ref: "#/components/schemas/Schema"
type:
- array
- "null"
anyOf:
items:
$ref: "#/components/schemas/Schema"
type:
- array
- "null"
const: {}
contains:
$ref: "#/components/schemas/Schema"
contentEncoding:
type: string
contentMediaType:
type: string
contentSchema:
$ref: "#/components/schemas/Schema"
default: {}
definitions:
additionalProperties:
$ref: "#/components/schemas/Schema"
type: object
dependentRequired:
additionalProperties:
items:
type: string
type:
- array
- "null"
type: object
dependentSchemas:
additionalProperties:
$ref: "#/components/schemas/Schema"
type: object
deprecated:
type: boolean
description:
type: string
else:
$ref: "#/components/schemas/Schema"
enum:
items: {}
type:
- array
- "null"
examples:
items: {}
type:
- array
- "null"
exclusiveMaximum:
format: double
type: number
exclusiveMinimum:
format: double
type: number
format:
type: string
if:
$ref: "#/components/schemas/Schema"
maxContains:
format: int64
type: integer
maxItems:
format: int64
type: integer
maxLength:
format: int64
type: integer
maxProperties:
format: int64
type: integer
maximum:
format: double
type: number
minContains:
format: int64
type: integer
minItems:
format: int64
type: integer
minLength:
format: int64
type: integer
minProperties:
format: int64
type: integer
minimum:
format: double
type: number
multipleOf:
format: double
type: number
not:
$ref: "#/components/schemas/Schema"
oneOf:
items:
$ref: "#/components/schemas/Schema"
type:
- array
- "null"
pattern:
type: string
patternProperties:
additionalProperties:
$ref: "#/components/schemas/Schema"
type: object
prefixItems:
items:
$ref: "#/components/schemas/Schema"
type:
- array
- "null"
properties:
additionalProperties:
$ref: "#/components/schemas/Schema"
type: object
propertyNames:
$ref: "#/components/schemas/Schema"
readOnly:
type: boolean
required:
items:
type: string
type:
- array
- "null"
then:
$ref: "#/components/schemas/Schema"
title:
type: string
unevaluatedItems:
$ref: "#/components/schemas/Schema"
unevaluatedProperties:
$ref: "#/components/schemas/Schema"
uniqueItems:
type: boolean
writeOnly:
type: boolean
type: object
SendInputBody:
additionalProperties: false
properties:
page:
maxLength: 500
type: string
page_label:
maxLength: 200
type: string
text:
minLength: 1
type: string
required:
- text
type: object
SignInInputBody:
additionalProperties: false
properties:
email:
type: string
password:
type: string
required:
- email
- password
type: object
SystemAdminToken:
additionalProperties: false
properties:
token:
description: Shown once; only its hash is written to the config
type: string
required:
- token
type: object
SystemBootstrap:
additionalProperties: false
properties:
admin_token_hash_prefix:
type: string
admin_token_set:
type: boolean
database_host:
type: string
listen:
type: string
schemas:
format: int64
type: integer
sealing_identity_set:
type: boolean
required:
- listen
- database_host
- schemas
- admin_token_hash_prefix
- admin_token_set
- sealing_identity_set
type: object
TextInputBody:
additionalProperties: false
properties:
text:
description: The note itself. A credential-shaped value is redacted, and a credential or a security override is refused.
type: string
required:
- text
type: object
Usage:
additionalProperties: false
properties:
cache_creation_tokens:
format: int64
type: integer
cached_tokens:
format: int64
type: integer
completion_tokens:
format: int64
type: integer
prompt_tokens:
format: int64
type: integer
total_tokens:
format: int64
type: integer
required:
- prompt_tokens
- completion_tokens
- total_tokens
type: object
securitySchemes:
bearer:
description: A personal API token, or the bootstrap admin token
scheme: bearer
type: http
session:
description: The session a browser sign-in opens
in: cookie
name: archie_session
type: apiKey
info:
title: Archie
version: dev
openapi: 3.1.0
paths:
/api/account/passkeys:
get:
operationId: list-passkeys
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernancePasskeysBody"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List your passkeys
tags:
- Accounts
/api/account/passkeys/begin:
post:
operationId: begin-passkey-registration
parameters:
- in: cookie
name: archie_session
schema:
type: string
responses:
"200":
content:
application/json:
schema: {}
description: OK
headers:
Cache-Control:
schema:
type: string
Set-Cookie:
schema:
type: string
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Start adding a passkey
tags:
- Accounts
/api/account/passkeys/finish:
post:
operationId: finish-passkey-registration
parameters:
- in: cookie
name: archie_session
schema:
type: string
- in: cookie
name: archie_passkey_registration
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/GovernancePasskeyFinishBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceUserBody"
description: OK
headers:
Cache-Control:
schema:
type: string
Set-Cookie:
schema:
type: string
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Finish adding a passkey
tags:
- Accounts
/api/account/passkeys/{id}:
delete:
operationId: delete-passkey
parameters:
- in: cookie
name: archie_session
schema:
type: string
- in: path
name: id
required: true
schema:
type: string
responses:
"204":
description: No Content
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Remove a passkey
tags:
- Accounts
/api/account/password:
post:
operationId: change-password
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ChangePasswordInputBody"
required: true
responses:
"204":
description: No Content
headers:
Cache-Control:
schema:
type: string
Set-Cookie:
schema:
type: string
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Change your password
tags:
- Accounts
/api/account/recovery:
post:
operationId: create-recovery-code
parameters:
- in: cookie
name: archie_session
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/RecoveryCodeReplyBody"
description: OK
headers:
Cache-Control:
schema:
type: string
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Create a recovery code
tags:
- Accounts
/api/accounts:
post:
operationId: create-account
parameters:
- in: cookie
name: archie_session
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceRegistration"
required: true
responses:
"201":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceUserBody"
description: Created
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Create an account
tags:
- Accounts
/api/admin/token:
post:
operationId: rotate-admin-token
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/SystemAdminToken"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Rotate the admin token; the new one is shown once
tags:
- System
/api/approvals:
get:
operationId: list-approvals
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/ApprovalsView"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List approval requests waiting for an answer
tags:
- Approvals
/api/approvals/{id}/answer:
post:
operationId: answer-approval
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/AnswerInputBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ApprovalsView"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Approve or refuse an action as the bootstrap admin
tags:
- Approvals
/api/auth/login:
post:
operationId: sign-in
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/SignInInputBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceUserBody"
description: OK
headers:
Cache-Control:
schema:
type: string
Set-Cookie:
schema:
type: string
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
security:
- {}
summary: Sign in with email and password
tags:
- Accounts
/api/auth/logout:
post:
operationId: sign-out
parameters:
- in: cookie
name: archie_session
schema:
type: string
responses:
"204":
description: No Content
headers:
Cache-Control:
schema:
type: string
Set-Cookie:
schema:
type: string
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
security:
- {}
summary: Sign out
tags:
- Accounts
/api/auth/passkey/begin:
post:
operationId: begin-passkey-sign-in
parameters:
- in: cookie
name: archie_session
schema:
type: string
responses:
"200":
content:
application/json:
schema: {}
description: OK
headers:
Cache-Control:
schema:
type: string
Set-Cookie:
schema:
type: string
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
security:
- {}
summary: Start signing in with a passkey
tags:
- Accounts
/api/auth/passkey/finish:
post:
operationId: finish-passkey-sign-in
parameters:
- in: cookie
name: archie_passkey_login
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/GovernancePasskeyFinishBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceUserBody"
description: OK
headers:
Cache-Control:
schema:
type: string
Set-Cookie:
schema:
type: string
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
security:
- {}
summary: Finish signing in with a passkey
tags:
- Accounts
/api/auth/recover:
post:
operationId: recover-account
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/RecoverInputBody"
required: true
responses:
"204":
description: No Content
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
security:
- {}
summary: Reset a password with a recovery code
tags:
- Accounts
/api/auth/setup:
post:
operationId: set-up-account
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceRegistration"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceUserBody"
description: OK
headers:
Cache-Control:
schema:
type: string
Set-Cookie:
schema:
type: string
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
security:
- {}
summary: Create the instance owner and sign in
tags:
- Accounts
/api/auth/status:
get:
operationId: get-auth-status
parameters:
- in: cookie
name: archie_session
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceAuthStatusBody"
description: OK
headers:
Cache-Control:
schema:
type: string
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
security:
- {}
summary: Report setup and who is signed in
tags:
- Accounts
/api/authentication:
get:
operationId: get-authentication
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceAuthenticationSettings"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Get the authentication settings
tags:
- Accounts
put:
operationId: put-authentication
parameters:
- in: cookie
name: archie_session
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/AuthenticationInputBody"
required: true
responses:
"204":
description: No Content
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Change the authentication settings
tags:
- Accounts
/api/capabilities:
get:
operationId: get-capabilities
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceCapabilitiesBody"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Report which dashboard sections this binary serves
tags:
- Accounts
/api/chat/sessions:
get:
operationId: list-chat-sessions
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ChatSessions"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List conversations, most recently active first, with the model that answers
tags:
- Chat
post:
operationId: create-chat-session
responses:
"201":
content:
application/json:
schema:
$ref: "#/components/schemas/ChatSession"
description: Created
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Start a conversation
tags:
- Chat
/api/chat/sessions/{id}:
delete:
operationId: delete-chat-session
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
responses:
"204":
description: No Content
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Delete a conversation and its turns
tags:
- Chat
patch:
operationId: rename-chat-session
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/RenameInputBody1"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ChatSession"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Rename a conversation
tags:
- Chat
/api/chat/sessions/{id}/turns:
get:
operationId: list-chat-turns
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/ChatTurn"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List a conversation's turns with what each did
tags:
- Chat
post:
operationId: send-chat-turn
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/SendInputBody"
required: true
responses:
"202":
content:
application/json:
schema:
$ref: "#/components/schemas/ChatTurn"
description: Accepted
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Send a message; it is stored, then answered after the turns before it
tags:
- Chat
/api/chat/turns/{id}:
get:
operationId: get-chat-turn
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ChatTurn"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Get one turn with what it did
tags:
- Chat
/api/chat/turns/{id}/cancel:
post:
operationId: cancel-chat-turn
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ChatTurn"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Stop a turn that is queued or running
tags:
- Chat
/api/chat/turns/{id}/events:
get:
operationId: stream-chat-turn
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
- description: Only events after this seq; every event by default
explode: false
in: query
name: after
schema:
description: Only events after this seq; every event by default
type: string
responses:
"200":
content:
text/event-stream:
schema:
type: string
description: "Server-sent events, one data frame per recorded event: {\"seq\", \"type\", ...}. Types are reasoning, delta, tool, navigate, approval, action, done, error and cancelled; the stream ends after done, error or cancelled."
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Stream what a turn records, from a cursor, until it ends
tags:
- Chat
/api/classes:
get:
operationId: list-classes
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/JudgementClassView"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List action classes with their earned levels
tags:
- Controls
/api/classes/{id}:
get:
operationId: get-class
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/JudgementClassDetail"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Get an action class with its history and outcomes
tags:
- Controls
/api/classes/{id}/reset:
post:
operationId: reset-class
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/JudgementClassView"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Reset an action class to its default level
tags:
- Controls
/api/composer/messages:
get:
operationId: list-composer-messages
parameters:
- description: Only messages after this seq; the latest page by default
explode: false
in: query
name: after
schema:
description: Only messages after this seq; the latest page by default
type: string
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/DeliveriesMessage"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List composer messages with their delivery attempts
tags:
- Composer
/api/composer/stream:
get:
operationId: stream-composer
responses:
"200":
content:
text/event-stream:
schema:
type: string
description: "Server-sent events: a message event carrying {\"seq\": n} for each new message, and a keepalive comment while idle"
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Stream the seq of each new composer message
tags:
- Composer
/api/connectors:
get:
operationId: list-connectors
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/ConnectorsExtensionView"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List accepted connectors
tags:
- Connectors
/api/connectors/{name}:
delete:
operationId: remove-connector
parameters:
- in: path
name: name
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectorsPackageState"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Remove an accepted package
tags:
- Connectors
put:
operationId: accept-connector
parameters:
- description: Lowercase letters, digits and hyphens
in: path
name: name
required: true
schema:
description: Lowercase letters, digits and hyphens
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectorsAcceptRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectorsPackageState"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Accept a package and start it
tags:
- Connectors
/api/controls/judges:
get:
operationId: list-judges
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/JudgementJudgeControl"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List each guard's judge, its standing and its eval date
tags:
- Controls
/api/credential-kinds:
get:
operationId: list-credential-kinds
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/ConnectorsCredentialKind"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List credential kinds and the fields each takes
tags:
- Credentials
/api/credentials:
get:
operationId: list-credentials
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/ConnectorsCredentialView"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List credentials, never their values
tags:
- Credentials
/api/credentials/{name}:
get:
operationId: get-credential
parameters:
- in: path
name: name
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectorsCredentialView"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Get a credential, never its values
tags:
- Credentials
put:
operationId: put-credential
parameters:
- description: Lowercase letters, digits and hyphens
in: path
name: name
required: true
schema:
description: Lowercase letters, digits and hyphens
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectorsCredentialRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectorsCredentialSaved"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Store a credential sealed and restart what uses it
tags:
- Credentials
/api/drafts:
get:
operationId: list-drafts
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/DraftsView"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List drafts
tags:
- Drafts
/api/drafts/{id}:
get:
operationId: get-draft
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DraftsView"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Get a draft
tags:
- Drafts
put:
operationId: edit-draft
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/EditInputBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DraftsView"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Change a draft's name, workflow and policy
tags:
- Drafts
/api/drafts/{id}/dry-run:
post:
operationId: dry-run-draft
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/DryRunInputBody"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DraftsView"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Replay a stored event against the draft workflow and policy in a dry run
tags:
- Drafts
/api/drafts/{id}/publish:
post:
operationId: publish-draft
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DraftsView"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Install the draft's workflow, policy and trigger
tags:
- Drafts
/api/events:
get:
operationId: list-events
parameters:
- explode: false
in: query
name: limit
schema:
default: 50
format: int64
maximum: 500
minimum: 1
type: integer
- explode: false
in: query
name: source
schema:
type: string
- explode: false
in: query
name: type
schema:
type: string
- description: Only events a trigger did or didn't match
explode: false
in: query
name: matched
schema:
description: Only events a trigger did or didn't match
enum:
- "true"
- "false"
type: string
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/EventsEventView"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List recent events
tags:
- Events
/api/events/{id}:
get:
operationId: get-event
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/EventsEventDetail"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Get an event with its payload and the runs it started
tags:
- Events
/api/extension-kinds:
get:
operationId: list-extension-kinds
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/ConnectorsExtensionKind"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List the kinds of extension and the group each belongs to
tags:
- Connectors
/api/groups:
get:
operationId: list-groups
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/EventsGroupView"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List groups of unmatched events
tags:
- Events
/api/groups/{id}/draft:
post:
operationId: draft-group
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DraftsView"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Draft a trigger and workflow for a group of unmatched events
tags:
- Drafts
/api/guards:
get:
operationId: list-guards
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/ConnectorsExtensionView"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List accepted guards
tags:
- Guards
/api/guards/{name}:
delete:
operationId: remove-guard
parameters:
- in: path
name: name
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectorsPackageState"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Remove an accepted package
tags:
- Guards
put:
operationId: accept-guard
parameters:
- description: Lowercase letters, digits and hyphens
in: path
name: name
required: true
schema:
description: Lowercase letters, digits and hyphens
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectorsAcceptRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectorsPackageState"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Accept a package and start it
tags:
- Guards
/api/mcp-servers:
get:
operationId: list-mcp-servers
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/ConnectorsExtensionView"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List accepted MCP servers
tags:
- MCP servers
/api/mcp-servers/{name}:
delete:
operationId: remove-mcp-server
parameters:
- in: path
name: name
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectorsPackageState"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Remove an accepted package
tags:
- MCP servers
put:
operationId: accept-mcp-server
parameters:
- description: Lowercase letters, digits and hyphens
in: path
name: name
required: true
schema:
description: Lowercase letters, digits and hyphens
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectorsMcpRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectorsPackageState"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Accept an MCP server and the tools it may offer
tags:
- MCP servers
/api/memory/notes:
get:
operationId: list-memory-notes
parameters:
- description: The memory class, durable facts by default
explode: false
in: query
name: class
schema:
description: The memory class, durable facts by default
enum:
- working_context
- episodic_history
- enterprise_retrieval
- durable_fact
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/MemoryNotes"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List the notes you may read
tags:
- Memory
post:
operationId: remember-memory-note
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/TextInputBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/MemoryNote"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Remember a note for yourself
tags:
- Memory
/api/memory/notes/{id}:
delete:
operationId: forget-memory-note
parameters:
- description: The note's id
in: path
name: id
required: true
schema:
description: The note's id
format: uuid
type: string
responses:
"204":
description: No Content
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Forget one of your notes
tags:
- Memory
patch:
operationId: correct-memory-note
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/CorrectInputBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/MemoryNote"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Correct one of your notes
tags:
- Memory
/api/memory/notes/{id}/disabled:
post:
operationId: disable-memory-note
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/DisabledInputBody"
required: true
responses:
"204":
description: No Content
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Stop one of your notes being read, or resume it
tags:
- Memory
/api/memory/proposals:
get:
operationId: list-note-proposals
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/MemoryNotes"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List notes waiting to be published
tags:
- Memory
post:
operationId: propose-shared-note
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/TextInputBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/MemoryNote"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Propose a note for the whole organisation
tags:
- Memory
/api/memory/proposals/{id}/publish:
post:
operationId: approve-note-proposal
parameters:
- description: The note's id
in: path
name: id
required: true
schema:
description: The note's id
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/MemoryNote"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Publish a proposed note
tags:
- Memory
/api/memory/shared:
get:
operationId: list-shared-notes
parameters:
- description: The memory class, durable facts by default
explode: false
in: query
name: class
schema:
description: The memory class, durable facts by default
enum:
- working_context
- episodic_history
- enterprise_retrieval
- durable_fact
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/MemoryNotes"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List the notes published to the organisation
tags:
- Memory
post:
operationId: publish-shared-note
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/TextInputBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/MemoryNote"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Publish a note to the whole organisation
tags:
- Memory
/api/memory/shared/{id}:
delete:
operationId: revoke-shared-note
parameters:
- description: The note's id
in: path
name: id
required: true
schema:
description: The note's id
format: uuid
type: string
responses:
"204":
description: No Content
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Revoke a shared note, published or proposed
tags:
- Memory
/api/memory/shared/{id}/rollback:
post:
operationId: roll-back-shared-note
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/RollbackInputBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/MemoryNote"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Publish an earlier version of a shared note again
tags:
- Memory
/api/memory/shared/{id}/versions:
get:
operationId: list-note-versions
parameters:
- description: The note's id
in: path
name: id
required: true
schema:
description: The note's id
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/MemoryVersions"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List the published versions of a shared note
tags:
- Memory
/api/orgs:
get:
operationId: list-orgs
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceOrgsBody"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List the organisation the caller acts in
tags:
- Organisations
/api/orgs/{id}:
get:
operationId: get-org
parameters:
- description: Organisation ID
in: path
name: id
required: true
schema:
description: Organisation ID
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceOrgBody"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Get an organisation
tags:
- Organisations
patch:
operationId: rename-org
parameters:
- description: Organisation ID
in: path
name: id
required: true
schema:
description: Organisation ID
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/RenameInputBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceOrgBody"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Rename an organisation
tags:
- Organisations
/api/orgs/{id}/history:
get:
operationId: list-org-events
parameters:
- description: Organisation ID
in: path
name: id
required: true
schema:
description: Organisation ID
type: string
- description: How many changes to return, at most 200
explode: false
in: query
name: limit
schema:
default: 50
description: How many changes to return, at most 200
format: int64
type: integer
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceOrgEventsBody"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List the organisation's name changes
tags:
- Organisations
/api/orgs/{id}/workspaces:
get:
operationId: list-org-workspaces
parameters:
- description: Organisation ID
in: path
name: id
required: true
schema:
description: Organisation ID
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceWorkspacesBody"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List an organisation's workspaces
tags:
- Organisations
post:
operationId: create-org-workspace
parameters:
- description: Organisation ID
in: path
name: id
required: true
schema:
description: Organisation ID
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/CreateWorkspaceInputBody"
required: true
responses:
"201":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceWorkspaceBody"
description: Created
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Create a workspace
tags:
- Organisations
/api/orgs/{id}/workspaces/{workspace}:
patch:
operationId: rename-org-workspace
parameters:
- description: Organisation ID
in: path
name: id
required: true
schema:
description: Organisation ID
type: string
- description: Workspace ID
in: path
name: workspace
required: true
schema:
description: Workspace ID
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/RenameWorkspaceInputBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceWorkspaceBody"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Rename a workspace
tags:
- Organisations
/api/people:
get:
operationId: list-people
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/GovernancePersonRequest"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List the people
tags:
- Governance
put:
operationId: put-people
requestBody:
content:
application/json:
schema:
items:
$ref: "#/components/schemas/GovernancePersonRequest"
type:
- array
- "null"
required: true
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/GovernancePersonRequest"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Replace the people
tags:
- Governance
/api/policies/change-request:
get:
operationId: get-change-request-rules
parameters:
- description: A past version; the current one by default
explode: false
in: query
name: version
schema:
description: A past version; the current one by default
format: int64
minimum: 1
type: integer
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/JudgementPolicySetView"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Get the change-request rules
tags:
- Controls
put:
operationId: put-change-request-rules
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PolicyInputBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/JudgementPolicySetView"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Replace the change-request rules with a new version
tags:
- Controls
/api/policies/hard-rules:
get:
operationId: get-hard-rules
parameters:
- description: A past version; the current one by default
explode: false
in: query
name: version
schema:
description: A past version; the current one by default
format: int64
minimum: 1
type: integer
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/JudgementPolicySetView"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Get the hard rules
tags:
- Controls
put:
operationId: put-hard-rules
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PolicyInputBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/JudgementPolicySetView"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Replace the hard rules with a new version
tags:
- Controls
/api/runs:
get:
operationId: list-runs
parameters:
- explode: false
in: query
name: limit
schema:
default: 50
format: int64
maximum: 200
minimum: 1
type: integer
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/RunsRunView"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List recent runs
tags:
- Runs
/api/runs/{id}:
get:
operationId: get-run
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/RunsTrail"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Get a run's decision trail
tags:
- Runs
/api/runs/{id}/retry:
post:
operationId: retry-run
parameters:
- in: path
name: id
required: true
schema:
format: uuid
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/RetryRunInputBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/RunsRunView"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Retry a parked run from a step, keeping the results of the steps before it
tags:
- Runs
/api/secret-engines:
get:
operationId: list-secret-engines
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/ConnectorsExtensionView"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List accepted secret engines
tags:
- Secret engines
/api/secret-engines/{name}:
delete:
operationId: remove-secret-engine
parameters:
- in: path
name: name
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectorsPackageState"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Remove an accepted package
tags:
- Secret engines
put:
operationId: accept-secret-engine
parameters:
- description: Lowercase letters, digits and hyphens
in: path
name: name
required: true
schema:
description: Lowercase letters, digits and hyphens
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectorsAcceptRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectorsPackageState"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Accept a package and start it
tags:
- Secret engines
/api/settings:
get:
operationId: get-settings
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceSettingsRequest"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Get the organisation settings
tags:
- Governance
put:
operationId: put-settings
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceSettingsRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceSettingsRequest"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Change the organisation settings
tags:
- Governance
/api/settings/agent-model:
get:
operationId: get-agent-model
parameters:
- description: Agent model alias; omit for the default model
explode: false
in: query
name: alias
schema:
description: Agent model alias; omit for the default model
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceModel"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Get the agent model
tags:
- Governance
put:
operationId: put-agent-model
parameters:
- description: Agent model alias; omit for the default model
explode: false
in: query
name: alias
schema:
description: Agent model alias; omit for the default model
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceModel"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceModel"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Set the agent model
tags:
- Governance
/api/settings/agent-model/test:
post:
operationId: test-agent-model
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceModel"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceModelAnswer"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Ask a model one question before saving it
tags:
- Governance
/api/settings/agent-models:
get:
operationId: list-agent-models
responses:
"200":
content:
application/json:
schema:
additionalProperties:
$ref: "#/components/schemas/GovernanceModel"
type: object
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List agent models by alias
tags:
- Governance
/api/sources:
get:
operationId: list-sources
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/EventsSourceView"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List sources
tags:
- Events
/api/sources/{name}:
put:
operationId: put-source
parameters:
- description: Lowercase letters, digits and hyphens; the webhook URL ends in it
in: path
name: name
required: true
schema:
description: Lowercase letters, digits and hyphens; the webhook URL ends in it
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PutSourceInputBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/EventsSourceCreated"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Add or update a source, its verification scheme and its token
tags:
- Events
/api/sources/{name}/key-fields:
put:
operationId: put-source-key-fields
parameters:
- in: path
name: name
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PutKeyFieldsInputBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/EventsKeyFieldsSaved"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Set the fields a source's events are grouped by
tags:
- Events
/api/stream:
get:
operationId: stream-dashboard
responses:
"200":
content:
text/event-stream:
schema:
type: string
description: "Server-sent events: one data frame of {\"topic\", \"data\"} per update, and a keepalive comment while idle"
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Stream live dashboard updates
tags:
- Dashboard
/api/system/bootstrap:
get:
operationId: get-bootstrap
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/SystemBootstrap"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Get the bootstrap values, which only the config file sets
tags:
- System
/api/tokens:
get:
operationId: list-personal-tokens
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceTokensBody"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List your personal API tokens
tags:
- Accounts
post:
operationId: create-personal-token
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/CreateTokenInputBody"
required: true
responses:
"201":
content:
application/json:
schema:
$ref: "#/components/schemas/GovernanceCreatedToken"
description: Created
headers:
Cache-Control:
schema:
type: string
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Create a personal API token
tags:
- Accounts
/api/tokens/{id}:
delete:
operationId: revoke-personal-token
parameters:
- in: path
name: id
required: true
schema:
type: string
responses:
"204":
description: No Content
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Revoke a personal API token
tags:
- Accounts
/api/triggers:
get:
operationId: list-triggers
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/EventsTriggerView"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List triggers
tags:
- Events
/api/triggers/{name}:
put:
operationId: put-trigger
parameters:
- description: Lowercase letters, digits and hyphens
in: path
name: name
required: true
schema:
description: Lowercase letters, digits and hyphens
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PutTriggerInputBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/EventsTriggerSaved"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Add or change a trigger
tags:
- Events
/api/workflow-step-types:
get:
operationId: list-workflow-step-types
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/RunsStepType"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List the step types a workflow document may name, with their settings schemas
tags:
- Workflows
/api/workflows:
get:
operationId: list-workflows
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/RunsWorkflowView"
type:
- array
- "null"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: List every workflow at its latest version
tags:
- Workflows
/api/workflows/{name}:
get:
operationId: get-workflow
parameters:
- in: path
name: name
required: true
schema:
type: string
- description: A past version; the latest by default
explode: false
in: query
name: version
schema:
description: A past version; the latest by default
format: int64
minimum: 1
type: integer
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/RunsWorkflowView"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Get a workflow
tags:
- Workflows
put:
operationId: put-workflow
parameters:
- description: Lowercase letters and digits, joined by dots or hyphens
in: path
name: name
required: true
schema:
description: Lowercase letters and digits, joined by dots or hyphens
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PutWorkflowInputBody"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/RunsWorkflowView"
description: OK
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
summary: Save a workflow document as its next version
tags:
- Workflows
/oauth2/callback:
get:
operationId: finish-oidc-sign-in
parameters:
- explode: false
in: query
name: code
schema:
type: string
- explode: false
in: query
name: state
schema:
type: string
- explode: false
in: query
name: error
schema:
type: string
- in: cookie
name: archie_login_state
schema:
type: string
- in: cookie
name: archie_login_verifier
schema:
type: string
responses:
"303":
description: See Other
headers:
Cache-Control:
schema:
type: string
Location:
schema:
type: string
Set-Cookie:
schema:
type: string
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
security:
- {}
summary: Complete the identity provider's sign-in
tags:
- Accounts
/oauth2/login:
get:
operationId: begin-oidc-sign-in
parameters:
- in: cookie
name: archie_session
schema:
type: string
responses:
"303":
description: See Other
headers:
Cache-Control:
schema:
type: string
Location:
schema:
type: string
Set-Cookie:
schema:
type: string
default:
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ErrorModel"
description: Error
security:
- {}
summary: Send the browser to the identity provider
tags:
- Accounts
security:
- session: []
- bearer: []