Hamad Bin Khalifa University

Hamad Bin Khalifa University Models API

The Models API from Hamad Bin Khalifa University — 1 operation(s) for models.

GitHub OpenAPI

Operations 1

GET /v1/models List Models #

Documentation

📖
APIReference
https://api.fanar.qa/docs
📖
Documentation
https://fanar.qa/en
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/hbku/refs/heads/main/authentication/hbku-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/hbku/refs/heads/main/rate-limits/hbku-rate-limits.yml
📖
Documentation
https://farasa.qcri.org/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/hbku/refs/heads/main/openapi/hbku-models-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hbku/refs/heads/main/json-schema/hbku-fanar-error-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hbku/refs/heads/main/json-schema/hbku-fanar-models-response-schema.json

Other Resources

🔗
SignUp
https://api.fanar.qa/request/en
🔗
TermsOfService
https://fanar.qa/en/terms-of-services
🔗
PrivacyPolicy
https://fanar.qa/en/privacy-policy
🔗
ReleaseNotes
https://fanar.qa/en/2-0-release-notes
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/hbku/refs/heads/main/errors/hbku-fanar-errors.yml
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/hbku/refs/heads/main/examples/hbku-fanar-models-401-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/hbku/refs/heads/main/examples/hbku-fanar-chat-completion-example.json
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/hbku/refs/heads/main/lifecycle/hbku-lifecycle.yml
🔗
SourceCode
https://huggingface.co/QCRI
🔗
Reference
https://alt.qcri.org/farasa/
🔗
SignUp
https://farasa.qcri.org/
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/hbku/refs/heads/main/examples/hbku-farasa-invalid-key-example.json

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/hbku-models-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 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.

GitHub Google LinkedIn

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

OpenAPI Specification

hbku-models-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Fanar Models API
  description: You can interact with FanarAPI for seamless chat completion and text processing using Fanar.
  termsOfService: https://fanar.qa/terms-of-services
  contact:
    name: Fanar Support
    url: https://fanar.qa/
    email: support@fanar.qa
  version: 1.0.0
  x-logo:
    url: /static/white-logo.svg
    alt: logo
security:
- Bearer: []
tags:
- name: Models
paths:
  /v1/models:
    get:
      tags:
      - Models
      summary: List Models
      description: Lists the currently available models.
      operationId: list_models_v1_models_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelsResponse'
        '400':
          description: The content was filtered
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: content_filter
                  message: The content was filtered
                  status: 400
                  param: prompt
                  type: safety
        '401':
          description: Invalid authentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: invalid_authentication
                  message: Invalid authentication
                  status: 401
        '403':
          description: Invalid authorization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: invalid_authorization
                  message: Invalid authorization
                  status: 403
        '429':
          description: Rate limit reached or Exceeded quota
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: exceeded_quota
                  message: Exceeded quota
                  status: 429
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: internal_server_error
                  message: Internal server error
                  status: 500
        '503':
          description: Service overloaded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: overloaded
                  message: Service overloaded
                  status: 503
        '504':
          description: Request timed out
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: timeout
                  message: Request timed out
                  status: 504
        '413':
          description: Request entity too large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: too_large
                  message: Request entity too large
                  status: 413
        '422':
          description: Unprocessable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: unprocessable
                  message: Unprocessable
                  status: 422
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: conflict
                  message: Conflict
                  status: 409
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: Not found
                  message: Not found
                  status: 404
        '410':
          description: No longer supported
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: no_longer_supported
                  message: No longer supported
                  status: 410
        '499':
          description: Client closed request before completion
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: client_closed_request
                  message: Client closed request before completion
                  status: 499
      security:
      - Bearer: []
      x-codeSamples:
      - lang: Curl
        label: cURL
        source: "curl -X GET \"https://api.fanar.qa/v1/models\" \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\"\n"
      - lang: Python
        label: Python - requests
        source: "import requests\n\nheaders = {\n    \"Authorization\": \"Bearer YOUR_API_KEY\",\n    \"Content-Type\": \"application/json\",\n}\n\nresponse = requests.get(\"https://api.fanar.qa/v1/models\", headers=headers)\n\nprint(response.json())"
components:
  schemas:
    ErrorCode:
      type: string
      enum:
      - content_filter
      - invalid_authentication
      - invalid_authorization
      - rate_limit_reached
      - exceeded_quota
      - internal_server_error
      - overloaded
      - timeout
      - too_large
      - unprocessable
      - conflict
      - Not found
      - no_longer_supported
      - client_closed_request
      title: ErrorCode
    ModelObject:
      type: string
      enum:
      - model
      title: ModelObject
    AvailableModel:
      properties:
        id:
          type: string
          title: Id
          description: A unique identifier for the model.
        object:
          $ref: '#/components/schemas/ModelObject'
          description: The type of object.
        created:
          type: integer
          title: Created
          description: The creation timestamp of the model.
        owned_by:
          type: string
          title: Owned By
          description: The owner of the model.
      type: object
      required:
      - id
      - object
      - created
      - owned_by
      title: AvailableModel
    ErrorContentFilterType:
      type: string
      enum:
      - safety
      - blocklist
      - incomplete
      title: ErrorContentFilterType
    Error:
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
          title: Message
          default: Internal server error
        status:
          $ref: '#/components/schemas/ErrorStatus'
          default: 500
        param:
          anyOf:
          - type: string
          - type: 'null'
          title: Param
        type:
          anyOf:
          - $ref: '#/components/schemas/ErrorContentFilterType'
          - type: 'null'
      type: object
      title: Error
    ModelsResponse:
      properties:
        id:
          type: string
          title: Id
          description: A unique identifier for the models.
        models:
          items:
            $ref: '#/components/schemas/AvailableModel'
          type: array
          title: Models
          description: The available models.
      type: object
      required:
      - id
      - models
      title: ModelsResponse
    ErrorStatus:
      type: integer
      enum:
      - 400
      - 401
      - 403
      - 429
      - 429
      - 500
      - 503
      - 504
      - 413
      - 422
      - 409
      - 404
      - 410
      - 499
      title: ErrorStatus
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      description: Provide your API key in the Authorization header using the Bearer scheme.