Custom Instructions

Workspace agent directives.

4 actions. Each is callable by the agent as a tool, over HTTP via /api/invoke, and (usually) from a UI page.

`instructions.list`

GET

List custom instructions the agent reads as part of its system prompt. Filter by scope (global / project / mission / actor).

AI tool: instructions_list
API: GET /api/invoke/instructions.list

Input

Field	Type	Required
`scope`	"global" \| "project" \| "mission" \| "actor"	—
`projectId`	string	—
`missionId`	string	—
`actorId`	string	—
`limit`	integer	—
`offset`	integer	—
`orderBy`	string	—
`orderDir`	"asc" \| "desc"	—
`q`	string	—

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "enum": [
        "global",
        "project",
        "mission",
        "actor"
      ]
    },
    "projectId": {
      "type": "string",
      "minLength": 1
    },
    "missionId": {
      "type": "string",
      "minLength": 1
    },
    "actorId": {
      "type": "string",
      "minLength": 1
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 500
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "orderBy": {
      "type": "string"
    },
    "orderDir": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "q": {
      "type": "string"
    }
  }
}

`instructions.upsert`

POST · mutating

Create or update a custom instruction.

AI tool: instructions_upsert
API: POST /api/invoke/instructions.upsert

Input

Field	Type	Required
`id`	string	—
`title`	string	yes
`content`	string	—
`scope`	"global" \| "project" \| "mission" \| "actor"	—
`projectId`	string	—
`missionId`	string	—
`actorId`	string	—
`priority`	integer	—
`active`	boolean	—

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1
    },
    "title": {
      "type": "string"
    },
    "content": {
      "default": "",
      "type": "string"
    },
    "scope": {
      "default": "global",
      "type": "string",
      "enum": [
        "global",
        "project",
        "mission",
        "actor"
      ]
    },
    "projectId": {
      "type": "string",
      "minLength": 1
    },
    "missionId": {
      "type": "string",
      "minLength": 1
    },
    "actorId": {
      "type": "string",
      "minLength": 1
    },
    "priority": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "title"
  ]
}

`instructions.delete`

DELETE · mutating

Delete a custom instruction.

AI tool: instructions_delete
API: DELETE /api/invoke/instructions.delete

Input

Field	Type	Required	Description
`id`	string	yes

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "id"
  ]
}

`instructions.toggle`

POST · mutating

Flip the active flag on a custom instruction.

AI tool: instructions_toggle
API: POST /api/invoke/instructions.toggle

Input

Field	Type	Required	Description
`id`	string	yes
`active`	boolean	—

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id"
  ]
}