FiveM Docs Docs API

The Docs API from FiveM Docs — 3 operation(s) for docs.

GitHub OpenAPI

Operations 3

GET /api/docs/search Search public FiveM guides by keywords #
GET /api/docs/lookup Look up blip sprites, controls or ped models #
GET /api/docs/fetch Read a public guide using its exact search result ID #

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/fivemdocs-com:fivemdocs-com-docs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

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

OpenAPI Specification

fivemdocs-com-docs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: FiveM Docs API
  version: 1.0.0
  description: Read-only access to independent public FiveM documentation. Search by short keywords, then fetch a guide and cite its URL. Not official Cfx.re documentation. Interactive datasets are not expanded in guide text.
servers:
- url: https://fivemdocs.com
tags:
- name: Docs
paths:
  /api/docs/search:
    get:
      operationId: searchDocs
      summary: Search public FiveM guides by keywords
      description: All query terms must match the guide title, description, path or body. Returns up to ten results. Try fewer keywords if there are no matches.
      x-openai-isConsequential: false
      parameters:
      - name: query
        in: query
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 200
      responses:
        '200':
          description: Matching guides with canonical citation URLs
          content:
            application/json:
              schema:
                type: object
                required:
                - results
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/DocumentReference'
        '400':
          $ref: '#/components/responses/InvalidInput'
      tags:
      - Docs
  /api/docs/lookup:
    get:
      operationId: lookupGameReference
      summary: Look up blip sprites, controls or ped models
      description: Read-only lookup of imported website rows. Numeric IDs/hashes match exact values. Cite url and sourceUrl; retrievedAt is a snapshot date, not runtime acceptance or a license.
      x-openai-isConsequential: false
      parameters:
      - name: dataset
        in: query
        required: true
        schema:
          type: string
          enum:
          - blips
          - controls
          - ped-models
      - name: query
        in: query
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 100
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 20
          default: 10
      responses:
        '200':
          description: Matching rows and provenance; empty results when no match exists.
          content:
            application/json:
              schema:
                type: object
                required:
                - dataset
                - url
                - sourceUrl
                - retrievedAt
                - context
                - rightsUrl
                - total
                - truncated
                - results
                properties:
                  dataset:
                    type: string
                  url:
                    type: string
                  sourceUrl:
                    type: string
                  retrievedAt:
                    type: string
                  context:
                    type: string
                  rightsUrl:
                    type: string
                  total:
                    type: integer
                  truncated:
                    type: boolean
                  results:
                    type: array
                    maxItems: 20
                    items:
                      type: object
                      required:
                      - id
                      - section
                      - values
                      properties:
                        id:
                          type: string
                        section:
                          type: string
                        values:
                          type: object
                          additionalProperties:
                            type: string
        '400':
          $ref: '#/components/responses/InvalidInput'
      tags:
      - Docs
  /api/docs/fetch:
    get:
      operationId: fetchDoc
      summary: Read a public guide using its exact search result ID
      x-openai-isConsequential: false
      parameters:
      - name: id
        in: query
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 200
      responses:
        '200':
          description: Guide Markdown/MDX and canonical citation URL. Interactive tables are not expanded.
          content:
            application/json:
              schema:
                type: object
                required:
                - id
                - title
                - url
                - text
                properties:
                  id:
                    type: string
                  title:
                    type: string
                  url:
                    type: string
                    format: uri
                  text:
                    type: string
        '400':
          $ref: '#/components/responses/InvalidInput'
        '404':
          description: Document ID is not in the public documentation inventory
      tags:
      - Docs
components:
  schemas:
    DocumentReference:
      type: object
      required:
      - id
      - title
      - url
      properties:
        id:
          type: string
        title:
          type: string
        url:
          type: string
          format: uri
  responses:
    InvalidInput:
      description: Missing or invalid query parameter
      content:
        application/json:
          schema:
            type: object
            required:
            - error
            properties:
              error:
                type: string