> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agentsfleet.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Inspect a Plugin revision



## OpenAPI

````yaml https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/plugins/{plugin_id}
openapi: 3.1.0
info:
  title: agentsfleet API
  description: API for managing workspaces, fleets, triggers, and runs.
  contact:
    name: agentsfleet
    url: https://agentsfleet.net
  license:
    name: MIT
    identifier: MIT
  version: 1.0.0
servers:
  - url: https://api.agentsfleet.net
    description: Production
security: []
paths:
  /v1/workspaces/{workspace_id}/plugins/{plugin_id}:
    get:
      tags:
        - Plugins
      summary: Inspect a Plugin revision
      operationId: read_workspace_plugin
      parameters:
        - name: workspace_id
          in: path
          description: >-
            Workspace identifier (version 7 universally unique identifier, or
            UUID).
          required: true
          schema:
            type: string
        - name: plugin_id
          in: path
          description: >-
            Plugin identifier (version 7 universally unique identifier, or
            UUID).
          required: true
          schema:
            type: string
            format: uuid
        - name: revision_id
          in: query
          description: Pinned revision UUIDv7; defaults to current head
          required: false
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Native setup and current readiness
          headers:
            ETag:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Plugin'
        '400':
          description: The request is invalid
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemBody'
        '401':
          description: Authentication is missing, invalid, or not accepted by this endpoint
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemBody'
        '403':
          description: You do not have permission for this action
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemBody'
        '404':
          description: Plugin or revision unavailable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemBody'
        '429':
          description: A request or capacity limit has been reached
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemBody'
        '500':
          description: An internal server error occurred
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemBody'
        '503':
          description: A required service is unavailable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemBody'
      security:
        - BearerAuth: []
components:
  schemas:
    Plugin:
      type: object
      description: Selected reusable content and readiness for the current workspace.
      required:
        - card
        - head
        - review
        - etag
      properties:
        card:
          $ref: '#/components/schemas/Card_Value'
          description: Current entry card.
        etag:
          type: string
          description: Strong Plugin version.
        head:
          $ref: '#/components/schemas/Revision_Value_Value'
          description: Explicitly selected revision or current head.
        review:
          type: object
          description: Contextual current readiness.
    ProblemBody:
      type: object
      description: The body every refusal carries, under `application/problem+json`.
      required:
        - docs_uri
        - title
        - detail
        - error_code
        - request_id
      properties:
        action_id:
          type:
            - string
            - 'null'
          description: 'On that 409 only: the action the gate held.'
        current_state:
          type:
            - string
            - 'null'
          description: 'On a 409 only: the state that forbade the transition.'
        detail:
          type: string
          description: One sentence on what was refused and why.
        docs_uri:
          type: string
          description: Where the error code is documented.
        error_code:
          type: string
          description: The registry code, stable across releases.
        etag:
          type:
            - string
            - 'null'
          description: >-
            On a 412 only: the resource's current entity tag, to refetch and
            retry.
        gate_id:
          type:
            - string
            - 'null'
          description: 'On an answered approval gate''s 409 only: the gate that was answered.'
        outcome:
          type:
            - string
            - 'null'
          description: 'On that 409 only: the answer that stands.'
        request_id:
          type: string
          description: The request this refusal answers, for support.
        resolved_at:
          type:
            - string
            - 'null'
          format: date-time
          description: 'On that 409 only: when the standing answer was given.'
        resolved_by:
          type:
            - string
            - 'null'
          description: 'On that 409 only: who gave it.'
        title:
          type: string
          description: A short name for the refusal, safe to show a person.
        user_message:
          type:
            - string
            - 'null'
          description: A curated sentence for end users, where the code has one.
    Card_Value:
      type: object
      description: Reusable setup summary, excluding instructions and private chat text.
      required:
        - id
        - name
        - description
        - created_at
        - requirements
        - required_credentials_reasons
        - head_revision_id
        - etag
      properties:
        created_at:
          type: string
          format: date-time
          description: Creation timestamp, such as `2026-10-24T05:00:00.000Z`.
        description:
          type: string
          description: Authored description.
        etag:
          type: string
          description: Strong Plugin version.
        head_revision_id:
          type: string
          description: Immutable current head `UUIDv7`.
        id:
          type: string
          description: Entry `UUIDv7`.
        name:
          type: string
          description: Human label.
        required_credentials_reasons:
          description: Authored explanation keyed by credential name.
        requirements:
          type: object
          description: Declarative needs of the head revision.
    Revision_Value_Value:
      type: object
      description: Immutable reusable setup selected by its revision identifier.
      required:
        - id
        - plugin_id
        - revision
        - definition
        - canonical_digest
        - requirements
        - policy_semantics
        - created_at
      properties:
        canonical_digest:
          type: string
          description: Canonical content identity.
        created_at:
          type: string
          format: date-time
          description: Creation timestamp, such as `2026-10-24T05:00:00.000Z`.
        definition:
          $ref: '#/components/schemas/FleetDefinition'
          description: Validated native setup.
        id:
          type: string
          description: Revision `UUIDv7`.
        plugin_id:
          type: string
          description: Entry `UUIDv7`.
        policy_semantics:
          type: string
          description: Pinned policy meaning.
        requirements:
          type: object
          description: Immutable declarative needs.
        revision:
          type: string
          description: Decimal entry-local revision.
    FleetDefinition:
      type: object
      description: >-
        A complete native fleet setup: its description, instructions and
        configuration.
      required:
        - schema_version
        - description
        - instructions_md
        - config
      properties:
        config:
          $ref: '#/components/schemas/DefinitionConfig'
          description: The fleet's configuration.
        description:
          type: string
          description: >-
            Says what the fleet does, shown wherever it is listed. At most
            32,768

            characters.
          maxLength: 32768
          minLength: 1
        instructions_md:
          type: string
          description: The fleet's instructions, in Markdown, at most 32,768 characters.
          maxLength: 32768
        schema_version:
          type: integer
          format: int32
          description: The Definition format version. Only `1` is accepted.
          maximum: 1
          minimum: 1
      additionalProperties: false
    DefinitionConfig:
      type: object
      description: >-
        The `config` member of a Definition: the fleet's name and its runtime
        settings.
      required:
        - name
        - x-agentsfleet
      properties:
        name:
          type: string
          description: The fleet's name.
          maxLength: 64
          minLength: 1
        x-agentsfleet:
          $ref: '#/components/schemas/DefinitionRuntime'
          description: >-
            Every runtime setting: triggers, tools, credentials, network, budget
            and gates.
      additionalProperties: false
    DefinitionRuntime:
      type: object
      description: The `x-agentsfleet` block, which holds every runtime setting.
      required:
        - tools
        - budget
      properties:
        budget:
          $ref: '#/components/schemas/DefinitionBudget'
          description: The most this fleet may spend.
        context:
          oneOf:
            - $ref: '#/components/schemas/DefinitionContext'
              description: Context-size settings for each run.
            - type: 'null'
        credentials:
          type:
            - array
            - 'null'
          items:
            type: string
            maxLength: 128
            minLength: 1
          description: The workspace secrets this fleet may read, by name.
          maxItems: 64
        decision_policy:
          $ref: '#/components/schemas/DefinitionDecisionPolicy'
          description: >-
            Owner-reviewed routing and completion questions, versioned with this
            setup.

            Omit for ordinary fleets; an explicit null or partial policy is
            refused.
        gates:
          oneOf:
            - $ref: '#/components/schemas/DefinitionGates'
              description: >-
                Which tool actions need a person's approval, and which repeated
                actions stop a run.
            - type: 'null'
        model:
          type:
            - string
            - 'null'
          description: The model this fleet runs on, passed to the runner unchanged.
          maxLength: 255
        network:
          oneOf:
            - $ref: '#/components/schemas/DefinitionNetwork'
              description: The hosts this fleet may reach.
            - type: 'null'
        repositories:
          type:
            - array
            - 'null'
          items:
            type: string
            maxLength: 255
            minLength: 1
          description: >-
            The repositories this fleet's GitHub credentials may reach, as
            `owner/name`.

            Set together with `repository_access`.
          maxItems: 64
          minItems: 1
        repository_access:
          oneOf:
            - $ref: '#/components/schemas/DefinitionRepositoryAccess'
              description: >-
                How far those credentials reach. Set together with
                `repositories`.
            - type: 'null'
        repository_base:
          type:
            - string
            - 'null'
          description: >-
            The branch every pull request opens against. Required with `write`,
            refused with `read`.
          maxLength: 255
          minLength: 1
        repository_publication:
          oneOf:
            - $ref: '#/components/schemas/RepositoryPublication'
              description: >-
                Reviewed write mode; `existing_pr` reserves branch publication
                for native tasks.
            - type: 'null'
        repository_validation_workflows:
          oneOf:
            - $ref: '#/components/schemas/ValidationWorkflows'
              description: >-
                Exact owner-reviewed validation-only workflows for existing PR
                publication.
            - type: 'null'
        tools:
          type: array
          items:
            type: string
            maxLength: 128
            minLength: 1
          description: >-
            The tools this fleet may call. An empty list means the fleet only
            answers.
          maxItems: 128
        triggers:
          type: array
          items:
            $ref: '#/components/schemas/DefinitionTrigger'
          description: >-
            What may start a run of this fleet besides a message sent to it.
            Omit

            it, or leave it empty, for a fleet that is only ever talked to.
          maxItems: 8
      additionalProperties: false
    DefinitionBudget:
      type: object
      description: Spending limits, each a decimal string of whole nanos.
      required:
        - daily_nanos
      properties:
        daily_nanos:
          type: string
          description: 'The daily limit: a decimal string of whole nanos, greater than zero.'
          maxLength: 19
          minLength: 1
          pattern: ^[0-9]+$
        monthly_nanos:
          type: string
          description: >-
            The monthly limit, in the same form. Omit it to set no monthly
            limit.
          maxLength: 19
          minLength: 1
          pattern: ^[0-9]+$
      additionalProperties: false
    DefinitionContext:
      type: object
      description: Context-size settings for each run.
      properties:
        context_cap_tokens:
          oneOf:
            - $ref: '#/components/schemas/DefinitionContextSetting'
              description: The most tokens a run's assembled context may hold.
            - type: 'null'
        memory_checkpoint_every:
          oneOf:
            - $ref: '#/components/schemas/DefinitionContextSetting'
              description: How often a run saves its memory.
            - type: 'null'
        stage_chunk_threshold:
          type:
            - number
            - 'null'
          format: double
          description: >-
            The fraction of the context, from 0 to 1, at which a stage splits
            into chunks.

            Zero means the runner chooses.
          maximum: 1
          minimum: 0
        tool_window:
          oneOf:
            - $ref: '#/components/schemas/DefinitionContextSetting'
              description: How much of the context tool output may fill.
            - type: 'null'
      additionalProperties: false
    DefinitionDecisionPolicy:
      type: object
      description: >-
        Editable decision questions, saved inside the existing fleet setup
        revision.
      required:
        - routing
        - completion
      properties:
        completion:
          $ref: '#/components/schemas/DefinitionCompletionQuestions'
          description: Every required completion statement and next-action criterion.
        routing:
          $ref: '#/components/schemas/DefinitionRoutingQuestions'
          description: >-
            All message-routing questions; omission never supplies hidden
            defaults.
      additionalProperties: false
    DefinitionGates:
      type: object
      description: Approval and anomaly rules for a fleet's tool actions.
      properties:
        anomaly_rules:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/DefinitionAnomalyRule'
          description: The repeated-action patterns that stop a run.
        rules:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/DefinitionGateRule'
          description: The tool actions that need a person's approval.
        timeout_ms:
          type:
            - integer
            - 'null'
          format: int64
          description: |-
            How long, in milliseconds, an approval may wait before it lapses.
            An out-of-range value is clamped to the nearest allowed one.
      additionalProperties: false
    DefinitionNetwork:
      type: object
      description: Where a fleet may reach on the network.
      properties:
        allow:
          type:
            - array
            - 'null'
          items:
            type: string
            maxLength: 255
            minLength: 1
          description: Additional exact hosts the fleet may reach.
          maxItems: 64
        http_egress:
          oneOf:
            - $ref: '#/components/schemas/DefinitionHttpEgress'
              description: HTTP destination scope. Omit for restricted access.
            - type: 'null'
          description: 'Beta: this field may change shape before it is stable.'
          x-stability: beta
        package_manager_domains:
          type:
            - boolean
            - 'null'
          description: >-
            Whether HTTP tools may reach standard package registry domains.
            Beta: this field may change shape before it is stable.
          x-stability: beta
        read_only:
          type:
            - boolean
            - 'null'
          description: Whether outbound requests are limited to reads.
        read_post_paths:
          type:
            - array
            - 'null'
          items:
            type: string
            maxLength: 255
            minLength: 1
          description: >-
            The request paths that may still send `POST` when `read_only` is
            true.
          maxItems: 64
      additionalProperties: false
    DefinitionRepositoryAccess:
      type: string
      description: How far a fleet's repository credentials reach.
      enum:
        - read
        - write
    RepositoryPublication:
      type: string
      description: Publication authority explicitly reviewed with the fleet setup.
      enum:
        - event_draft
        - existing_pr
    ValidationWorkflows:
      type: array
      items:
        $ref: '#/components/schemas/ValidationWorkflow'
      description: >-
        Keep collection bounds alongside element validation, including optional
        input.
    DefinitionTrigger:
      oneOf:
        - type: object
          description: Starts on a signed delivery from an external provider.
          required:
            - source
            - type
          properties:
            credential_name:
              type:
                - string
                - 'null'
              description: >-
                A secret name to use instead of the provider's default, so two
                fleets

                on one provider can hold different secrets.
              maxLength: 128
              minLength: 1
            events:
              type:
                - array
                - 'null'
              items:
                type: string
                maxLength: 64
                minLength: 1
              description: The event names that start a run. Omit it to accept every event.
              maxItems: 16
              minItems: 1
            repositories:
              type:
                - array
                - 'null'
              items:
                type: string
                maxLength: 255
                minLength: 1
              description: >-
                The repositories whose deliveries may start a run, as
                `owner/name`.
              maxItems: 64
              minItems: 1
            source:
              type: string
              description: >-
                The provider that sends the delivery, as a lowercase slug: it is
                the

                last segment of the URL the fleet's deliveries are sent to.
              maxLength: 255
              minLength: 1
            type:
              type: string
              enum:
                - webhook
            verifier:
              oneOf:
                - $ref: '#/components/schemas/DefinitionWebhookVerifier'
                  description: How the delivery proves it came from the provider.
                - type: 'null'
        - type: object
          description: Starts on a schedule.
          required:
            - schedule
            - type
          properties:
            message:
              type:
                - string
                - 'null'
              description: The message each scheduled run receives.
              maxLength: 255
            schedule:
              type: string
              description: The schedule, as a cron expression.
              maxLength: 255
              minLength: 1
            timezone:
              type:
                - string
                - 'null'
              description: The time zone the schedule is read in.
              maxLength: 255
              minLength: 1
            type:
              type: string
              enum:
                - cron
        - type: object
          description: Starts when someone mentions the bot in one chat channel.
          required:
            - source
            - channels
            - type
          properties:
            channels:
              type: array
              items:
                type: string
                maxLength: 32
                minLength: 9
              description: The channel identifier, as a list with exactly one entry.
              maxItems: 1
              minItems: 1
            source:
              type: string
              description: The chat provider.
              maxLength: 255
              minLength: 1
            type:
              type: string
              enum:
                - mention
      description: One way a fleet can start a run. `type` selects the kind.
    DefinitionContextSetting:
      oneOf:
        - type: integer
          format: int32
          description: An explicit value.
          minimum: 0
        - $ref: '#/components/schemas/DefinitionContextAuto'
          description: The word `auto`.
      description: A number, or `auto` to let the runner choose.
    DefinitionCompletionQuestions:
      type: object
      description: >-
        Semantic success conditions; native authority and evidence checks still
        apply.
      required:
        - statements
        - next_action
      properties:
        next_action:
          $ref: '#/components/schemas/DefinitionNextActionQuestion'
          description: 'Criteria keys: CONTINUE, WAIT, DONE, BLOCKED.'
        statements:
          type: array
          items:
            $ref: '#/components/schemas/DefinitionCompletionStatement'
          description: One to six required statements, with unique stable IDs.
          maxItems: 6
          minItems: 1
      additionalProperties: false
    DefinitionRoutingQuestions:
      type: object
      description: >-
        Routing questions assess the newest message against trusted task
        summaries.
      required:
        - intent
        - association
        - multiple_requests
      properties:
        association:
          $ref: '#/components/schemas/DefinitionAssociationQuestion'
          description: >-
            Criteria keys: `matching_task`, `new_work`, unclear. Candidate IDs
            stay native.
        intent:
          $ref: '#/components/schemas/DefinitionIntentQuestion'
          description: >-
            Criteria keys: conversation, status, refresh, steer, `new_work`,
            clarify.
        multiple_requests:
          $ref: '#/components/schemas/DefinitionNoulQuestion'
          description: 'Noul criteria keys: true and false.'
      additionalProperties: false
    DefinitionAnomalyRule:
      type: object
      description: One repeated-action pattern that stops a run.
      required:
        - pattern
        - threshold_count
        - threshold_window_s
      properties:
        pattern:
          $ref: '#/components/schemas/DefinitionAnomalyPattern'
          description: The pattern to watch for.
        threshold_count:
          type: integer
          format: int32
          description: How many repeats stop the run.
          maximum: 10000
          minimum: 1
        threshold_window_s:
          type: integer
          format: int32
          description: The window, in seconds, the repeats are counted in.
          maximum: 86400
          minimum: 1
      additionalProperties: false
    DefinitionGateRule:
      type: object
      description: |-
        One rule for when a tool action needs a person: a matching action always
        waits for a person's answer.
      required:
        - tool
        - action
      properties:
        action:
          type: string
          description: The action on that tool.
          maxLength: 128
          minLength: 1
        blast_radius:
          type: string
          description: How far an approval reaches, as shown to the person.
          maxLength: 255
        condition:
          type:
            - string
            - 'null'
          description: A condition that narrows when the rule applies.
          maxLength: 255
        gate_kind:
          type: string
          description: The kind of decision the person is asked to make.
          maxLength: 255
        tool:
          type: string
          description: The tool the rule watches.
          maxLength: 128
          minLength: 1
      additionalProperties: false
    DefinitionHttpEgress:
      type: string
      description: Which public HTTPS destinations a definition admits through HTTP tools.
      enum:
        - restricted
        - public
    ValidationWorkflow:
      type: object
      description: Exact workflow content reviewed by the owner as validation-only.
      required:
        - path
        - sha256
      properties:
        path:
          type: string
          description: Only a direct YAML file inside GitHub's workflow directory.
        sha256:
          type: string
          description: SHA-256 of the complete reviewed UTF-8 workflow text.
      additionalProperties: false
    DefinitionWebhookVerifier:
      oneOf:
        - type: object
          description: Raw body with a prefixed hex digest.
          required:
            - header
            - scheme
          properties:
            header:
              type: string
              description: Header holding the signature.
              maxLength: 128
              minLength: 1
              pattern: ^[!#$%&'*+.^_`|~0-9A-Za-z-]+$
            scheme:
              type: string
              enum:
                - body-hex-sha256
          additionalProperties: false
        - type: object
          description: Raw body with a bare hex digest.
          required:
            - header
            - scheme
          properties:
            header:
              type: string
              description: Header holding the signature.
              maxLength: 128
              minLength: 1
              pattern: ^[!#$%&'*+.^_`|~0-9A-Za-z-]+$
            scheme:
              type: string
              enum:
                - body-hex
          additionalProperties: false
        - type: object
          description: Raw body with a base64 digest.
          required:
            - header
            - scheme
          properties:
            header:
              type: string
              description: Header holding the signature.
              maxLength: 128
              minLength: 1
              pattern: ^[!#$%&'*+.^_`|~0-9A-Za-z-]+$
            scheme:
              type: string
              enum:
                - body-base64-sha256
          additionalProperties: false
        - type: object
          description: Fixed Slack headers with a signed timestamp.
          required:
            - scheme
          properties:
            scheme:
              type: string
              enum:
                - slack-v0
          additionalProperties: false
        - type: object
          description: Fixed Svix headers with a signed identifier and timestamp.
          required:
            - scheme
          properties:
            scheme:
              type: string
              enum:
                - svix-v1
          additionalProperties: false
      description: >-
        The complete signing recipe. Fixed-header recipes accept no extra
        fields.
    DefinitionContextAuto:
      type: string
      description: The only word a context setting accepts.
      enum:
        - auto
    DefinitionNextActionQuestion:
      type: object
      description: >-
        Owner-reviewed wording and exact native role criteria; complete authored
        JSON is at most 1 KiB.
      required:
        - question
        - criteria
      properties:
        criteria:
          type: object
          required:
            - CONTINUE
            - WAIT
            - DONE
            - BLOCKED
          properties:
            BLOCKED:
              type: string
              description: >-
                Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server
                also checks the encoded byte length.
              maxLength: 512
              minLength: 1
              pattern: ^[^\x00]*[^\s\x00][^\x00]*$
            CONTINUE:
              type: string
              description: >-
                Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server
                also checks the encoded byte length.
              maxLength: 512
              minLength: 1
              pattern: ^[^\x00]*[^\s\x00][^\x00]*$
            DONE:
              type: string
              description: >-
                Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server
                also checks the encoded byte length.
              maxLength: 512
              minLength: 1
              pattern: ^[^\x00]*[^\s\x00][^\x00]*$
            WAIT:
              type: string
              description: >-
                Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server
                also checks the encoded byte length.
              maxLength: 512
              minLength: 1
              pattern: ^[^\x00]*[^\s\x00][^\x00]*$
          additionalProperties: false
        question:
          type: string
          description: >-
            Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server also
            checks the encoded byte length.
          maxLength: 512
          minLength: 1
          pattern: ^[^\x00]*[^\s\x00][^\x00]*$
      additionalProperties: false
    DefinitionCompletionStatement:
      type: object
      description: >-
        One required probability-of-yes question, displayed separately from
        instructions.
      required:
        - id
        - question
        - criteria
      properties:
        criteria:
          $ref: '#/components/schemas/DefinitionNoulCriteria'
          description: >-
            Both true and false criteria are required; neither is a permission
            grant.
        id:
          type: string
          description: >-
            Stable owner-authored key; changing wording creates another setup
            revision.
          maxLength: 64
          minLength: 1
          pattern: ^[A-Za-z0-9_.-]+$
        question:
          type: string
          description: >-
            The completion question to assess against the task's accepted
            objective.
          maxLength: 512
          minLength: 1
          pattern: ^[^\x00]*[^\s\x00][^\x00]*$
      additionalProperties: false
    DefinitionAssociationQuestion:
      type: object
      description: >-
        Owner-reviewed wording and exact native role criteria; complete authored
        JSON is at most 1 KiB.
      required:
        - question
        - criteria
      properties:
        criteria:
          type: object
          required:
            - matching_task
            - new_work
            - unclear
          properties:
            matching_task:
              type: string
              description: >-
                Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server
                also checks the encoded byte length.
              maxLength: 512
              minLength: 1
              pattern: ^[^\x00]*[^\s\x00][^\x00]*$
            new_work:
              type: string
              description: >-
                Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server
                also checks the encoded byte length.
              maxLength: 512
              minLength: 1
              pattern: ^[^\x00]*[^\s\x00][^\x00]*$
            unclear:
              type: string
              description: >-
                Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server
                also checks the encoded byte length.
              maxLength: 512
              minLength: 1
              pattern: ^[^\x00]*[^\s\x00][^\x00]*$
          additionalProperties: false
        question:
          type: string
          description: >-
            Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server also
            checks the encoded byte length.
          maxLength: 512
          minLength: 1
          pattern: ^[^\x00]*[^\s\x00][^\x00]*$
      additionalProperties: false
    DefinitionIntentQuestion:
      type: object
      description: >-
        Owner-reviewed wording and exact native role criteria; complete authored
        JSON is at most 1 KiB.
      required:
        - question
        - criteria
      properties:
        criteria:
          type: object
          required:
            - conversation
            - status
            - refresh
            - steer
            - new_work
            - clarify
          properties:
            clarify:
              type: string
              description: >-
                Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server
                also checks the encoded byte length.
              maxLength: 512
              minLength: 1
              pattern: ^[^\x00]*[^\s\x00][^\x00]*$
            conversation:
              type: string
              description: >-
                Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server
                also checks the encoded byte length.
              maxLength: 512
              minLength: 1
              pattern: ^[^\x00]*[^\s\x00][^\x00]*$
            new_work:
              type: string
              description: >-
                Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server
                also checks the encoded byte length.
              maxLength: 512
              minLength: 1
              pattern: ^[^\x00]*[^\s\x00][^\x00]*$
            refresh:
              type: string
              description: >-
                Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server
                also checks the encoded byte length.
              maxLength: 512
              minLength: 1
              pattern: ^[^\x00]*[^\s\x00][^\x00]*$
            status:
              type: string
              description: >-
                Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server
                also checks the encoded byte length.
              maxLength: 512
              minLength: 1
              pattern: ^[^\x00]*[^\s\x00][^\x00]*$
            steer:
              type: string
              description: >-
                Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server
                also checks the encoded byte length.
              maxLength: 512
              minLength: 1
              pattern: ^[^\x00]*[^\s\x00][^\x00]*$
          additionalProperties: false
        question:
          type: string
          description: >-
            Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server also
            checks the encoded byte length.
          maxLength: 512
          minLength: 1
          pattern: ^[^\x00]*[^\s\x00][^\x00]*$
      additionalProperties: false
    DefinitionNoulQuestion:
      type: object
      description: >-
        Owner-reviewed wording and exact native role criteria; complete authored
        JSON is at most 1 KiB.
      required:
        - question
        - criteria
      properties:
        criteria:
          type: object
          required:
            - 'true'
            - 'false'
          properties:
            'false':
              type: string
              description: >-
                Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server
                also checks the encoded byte length.
              maxLength: 512
              minLength: 1
              pattern: ^[^\x00]*[^\s\x00][^\x00]*$
            'true':
              type: string
              description: >-
                Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server
                also checks the encoded byte length.
              maxLength: 512
              minLength: 1
              pattern: ^[^\x00]*[^\s\x00][^\x00]*$
          additionalProperties: false
        question:
          type: string
          description: >-
            Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server also
            checks the encoded byte length.
          maxLength: 512
          minLength: 1
          pattern: ^[^\x00]*[^\s\x00][^\x00]*$
      additionalProperties: false
    DefinitionAnomalyPattern:
      type: string
      description: A repeated-action pattern.
      enum:
        - same_action
    DefinitionNoulCriteria:
      type: object
      required:
        - 'true'
        - 'false'
      properties:
        'false':
          type: string
          description: >-
            Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server also
            checks the encoded byte length.
          maxLength: 512
          minLength: 1
          pattern: ^[^\x00]*[^\s\x00][^\x00]*$
        'true':
          type: string
          description: >-
            Nonblank, NUL-free text, at most 512 UTF-8 bytes. The server also
            checks the encoded byte length.
          maxLength: 512
          minLength: 1
          pattern: ^[^\x00]*[^\s\x00][^\x00]*$
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Send a dashboard session token, an account API key (`agt_t`), or a
        command-line credential (`afc_`) as a Bearer token. Each endpoint lists
        accepted credential types.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.