LocalAI Instructions API

The instructions API from LocalAI — 2 operation(s) for instructions.

Operations 2

GET /api/instructions List available API instruction areas
GET /api/instructions/{name} Get an instruction's API guide or OpenAPI fragment

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/localai-instructions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

localai-instructions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: The LocalAI Rest API.
  title: LocalAI Instructions API
  contact:
    name: LocalAI
    url: https://localai.io
  license:
    name: MIT
    url: https://raw.githubusercontent.com/mudler/LocalAI/master/LICENSE
  version: 2.0.0
servers:
- url: /
tags:
- name: instructions
paths:
  /api/instructions:
    get:
      description: Returns a compact list of instruction areas with descriptions and URLs for detailed guides
      tags:
      - instructions
      summary: List available API instruction areas
      responses:
        '200':
          description: instructions list with hint
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
  /api/instructions/{name}:
    get:
      description: Returns a markdown guide (default) or filtered OpenAPI fragment (format=json) for a named instruction
      tags:
      - instructions
      summary: Get an instruction's API guide or OpenAPI fragment
      parameters:
      - description: Instruction name (e.g. chat-inference, config-management)
        name: name
        in: path
        required: true
        schema:
          type: string
      - description: 'Response format: json for OpenAPI fragment, omit for markdown'
        name: format
        in: query
        schema:
          type: string
      responses:
        '200':
          description: instruction documentation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/localai.APIInstructionResponse'
            text/markdown:
              schema:
                $ref: '#/components/schemas/localai.APIInstructionResponse'
        '404':
          description: instruction not found
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/markdown:
              schema:
                type: object
                additionalProperties:
                  type: string
components:
  schemas:
    localai.APIInstructionResponse:
      type: object
      properties:
        description:
          type: string
        name:
          type: string
        swagger_fragment:
          type: object
          additionalProperties: {}
        tags:
          type: array
          items:
            type: string
  securitySchemes:
    BearerAuth:
      type: apiKey
      name: Authorization
      in: header