API Reference — subpackage_prompts.subpackage_prompts/runs

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_prompts.subpackage_prompts/runs
  description: 'API Reference — subpackage_prompts.subpackage_prompts/runs. 3 operations. Lead operation: ✨ Get inference
    run info. Self-contained Naftiko capability covering one Label Studio business surface.'
  tags:
  - Label Studio
  - subpackage_prompts.subpackage_prompts/runs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    LABEL_STUDIO_API_KEY: LABEL_STUDIO_API_KEY
capability:
  consumes:
  - type: http
    namespace: label-studio-subpackage-prompts-subpackage-prompts-runs
    baseUri: http://localhost:8000
    description: API Reference — subpackage_prompts.subpackage_prompts/runs business capability. Self-contained, no shared
      references.
    resources:
    - name: api-prompts-prompt_id-versions-version_id-inference-runs
      path: /api/prompts/{prompt_id}/versions/{version_id}/inference-runs
      operations:
      - name: list
        method: GET
        description: ✨ Get inference run info
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: prompt_id
          in: path
          type: integer
          required: true
        - name: version_id
          in: path
          type: integer
          required: true
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: parent_model
          in: query
          type: integer
          description: The ID of the parent model for this Inference Run
        - name: project
          in: query
          type: integer
          description: The ID of the project this Inference Run makes predictions on
        - name: project_subset
          in: query
          type: string
          description: Defines which tasks are operated on (e.g. HasGT will only operate on tasks with a ground truth annotation,
            but All will operate on all records)
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: create
        method: POST
        description: ✨ Run prompt inference
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: prompt_id
          in: path
          type: integer
          required: true
        - name: version_id
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-prompts-prompt_id-versions-version_id-inference-runs-inference_run_id-cancel
      path: /api/prompts/{prompt_id}/versions/{version_id}/inference-runs/{inference_run_id}/cancel
      operations:
      - name: cancel
        method: POST
        description: ✨ Cancel Inference Run API
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inference_run_id
          in: path
          type: integer
          required: true
        - name: prompt_id
          in: path
          type: integer
          required: true
        - name: version_id
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.LABEL_STUDIO_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: label-studio-subpackage-prompts-subpackage-prompts-runs-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_prompts.subpackage_prompts/runs. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/prompts/{prompt-id}/versions/{version-id}/inference-runs
      name: api-prompts-prompt-id-versions-version-id-inference-runs
      description: REST surface for api-prompts-prompt_id-versions-version_id-inference-runs.
      operations:
      - method: GET
        name: list
        description: ✨ Get inference run info
        call: label-studio-subpackage-prompts-subpackage-prompts-runs.list
        with:
          prompt_id: rest.prompt_id
          version_id: rest.version_id
          ordering: rest.ordering
          parent_model: rest.parent_model
          project: rest.project
          project_subset: rest.project_subset
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: create
        description: ✨ Run prompt inference
        call: label-studio-subpackage-prompts-subpackage-prompts-runs.create
        with:
          prompt_id: rest.prompt_id
          version_id: rest.version_id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/prompts/{prompt-id}/versions/{version-id}/inference-runs/{inference-run-id}/cancel
      name: api-prompts-prompt-id-versions-version-id-inference-runs-inference-run-id-cancel
      description: REST surface for api-prompts-prompt_id-versions-version_id-inference-runs-inference_run_id-cancel.
      operations:
      - method: POST
        name: cancel
        description: ✨ Cancel Inference Run API
        call: label-studio-subpackage-prompts-subpackage-prompts-runs.cancel
        with:
          inference_run_id: rest.inference_run_id
          prompt_id: rest.prompt_id
          version_id: rest.version_id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: label-studio-subpackage-prompts-subpackage-prompts-runs-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_prompts.subpackage_prompts/runs. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: get-inference-run-info
      description: ✨ Get inference run info
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-prompts-subpackage-prompts-runs.list
      with:
        prompt_id: tools.prompt_id
        version_id: tools.version_id
        ordering: tools.ordering
        parent_model: tools.parent_model
        project: tools.project
        project_subset: tools.project_subset
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: run-prompt-inference
      description: ✨ Run prompt inference
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio-subpackage-prompts-subpackage-prompts-runs.create
      with:
        prompt_id: tools.prompt_id
        version_id: tools.version_id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-inference-run-api
      description: ✨ Cancel Inference Run API
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio-subpackage-prompts-subpackage-prompts-runs.cancel
      with:
        inference_run_id: tools.inference_run_id
        prompt_id: tools.prompt_id
        version_id: tools.version_id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.