How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Fanar API

Fanar is Qatar's Arabic generative-AI platform, developed by the Qatar Computing Research Institute at Hamad Bin Khalifa University with support from Qatar's Ministry of Communications and Information Technology. The API publishes a first-party OpenAPI 3.1.0 document at api.fanar.qa/openapi.json: 11 paths and 12 operations spanning chat completions (streaming over text/event-stream), text-to-speech, transcription, custom voices, image generation, translation, poetry generation, moderation, tokenization and model listing. It is OpenAI-client compatible — the provider's own sample points the openai SDK at base_url https://api.fanar.qa/v1. Bearer authentication, fourteen documented error statuses behind a single Error envelope, and a published per-model rate-limit table with x-ratelimit-* and ratelimit-policy response headers. Access is by request. Verified live 2026-08-30: GET /v1/models returns 401 invalid_authentication.

Fanar API is one of 5 APIs that Hamad Bin Khalifa University publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Artificial Intelligence, Large Language Models, Arabic, Speech, and Translation. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, release notes, authentication docs, rate-limit docs, and 2 JSON Schemas.

This API exposes 12 operations across 11 paths, organized into 8 resource areas, and defines 97 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.fanar.qa.

12 operations 11 paths 97 schemas 1 DELETE2 GET9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.fanar.qa
Authentication
HTTP Bearer
Terms of Service
Resource Areas
8

Authentication & Security 1

Fanar API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer). By default, every request must be authenticated.

  • Bearer — Provide your API key in the Authorization header using the Bearer scheme.

Paths & Operations 12

Across 11 paths, the API surfaces 12 operations — 1 DELETE, 2 GET, 9 POST. They span 8 resource areas: Chat, Audio, Images, Translations, Poems, Moderations, Tokens, Models. Each is listed below with its method, path, parameters, and response codes.

Chat 1
POST
/v1/chat/completions
Create Chat Completion
create_chat_completion_v1_chat_completions_post body → 200400401403429500503504
Audio 5
POST
/v1/audio/speech
Create Speech
create_speech_v1_audio_speech_post body → 200400401403429500503504
POST
/v1/audio/transcriptions
Create Transcription
create_transcription_v1_audio_transcriptions_post body → 200400401403429500503504
GET
/v1/audio/voices
List Voices
list_voices_v1_audio_voices_get → 200400401403429500503504
POST
/v1/audio/voices
Create Voice
create_voice_v1_audio_voices_post body → 200400401403429500503504
DELETE
/v1/audio/voices/{name}
Delete Voice
delete_voice_v1_audio_voices__name__delete 1 param → 200400401403429500503504
Images 1
POST
/v1/images/generations
Create Image
create_image_v1_images_generations_post body → 200400401403429500503504
Translations 1
POST
/v1/translations
Translate
translate_v1_translations_post body → 200400401403429500503504
Poems 1
POST
/v1/poems/generations
Create Poem
create_poem_v1_poems_generations_post body → 200400401403429500503504
Moderations 1
POST
/v1/moderations
Identify Safety
identify_safety_v1_moderations_post body → 200401403429500503504413
Tokens 1
POST
/v1/tokens
Get Tokens
get_tokens_v1_tokens_post body → 200401403429500503504413
Models 1
GET
/v1/models
List Models
list_models_v1_models_get → 200400401403429500503504

Schemas 97

The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are ChatCompletionRequest (34 properties), DoneChunk (7 properties), Voice (7 properties), TextToSpeechRequest (7 properties). Each schema is shown below with its type and property counts.

AvailableModel
object
4 properties 4 required
Body_create_transcription_v1_audio_transcriptions_post
object
3 properties 2 required
Body_create_voice_v1_audio_voices_post
object
3 properties 3 required
BookNamesEnum
string
ChatCompletionAssistantMessageParam
object
4 properties 1 required
ChatCompletionChoice-Input
object
4 properties 3 required
ChatCompletionChoice-Output
object
4 properties 3 required
ChatCompletionChoiceMessage-Input
object
4 properties 1 required
ChatCompletionChoiceMessage-Output
object
4 properties 1 required
ChatCompletionChoiceMessageReference
object
4 properties 4 required
ChatCompletionContentAudio
object
2 properties 2 required
ChatCompletionContentImage
object
2 properties 2 required
ChatCompletionContentPartImageParam
object
2 properties 2 required
ChatCompletionContentPartRefusalParam
object
2 properties 2 required
ChatCompletionContentPartTextParam
object
2 properties 2 required
ChatCompletionContentPartVideoParam
object
2 properties 2 required
ChatCompletionContentText
object
2 properties 2 required
ChatCompletionLLM
string
ChatCompletionRequest
object
34 properties 2 required
ChatCompletionRequestVoiceLangaugePair
object
2 properties 1 required
ChatCompletionResponse
object
7 properties 4 required
ChatCompletionSystemMessageParam
object
3 properties 2 required
ChatCompletionThinkingMessageParam
object
2 properties 2 required
ChatCompletionThinkingUserMessageParam
object
2 properties 2 required
ChatCompletionTokenLogprob
object
4 properties 3 required
ChatCompletionToolCall
object
6 properties 3 required
ChatCompletionUserMessageParam
object
3 properties 2 required
ChoiceLogprobs-Input
object
2 properties
ChoiceLogprobs-Output
object
2 properties
CompletionTokensDetails
object
4 properties
CompletionUsage
object
5 properties 3 required
Error
object
5 properties
ErrorCode
string
ErrorContentFilterType
string
ErrorStatus
integer
ImageGenerationItem-Input
object
4 properties 4 required
ImageGenerationItem-Output
object
3 properties 3 required
ImageGenerationModels
string
ImageGenerationRequest
object
3 properties 2 required
ImageGenerationResponse
object
3 properties 3 required
ImageURL
object
2 properties 1 required
LLM
string
MadhabEnum
string
ModelObject
string
ModelsResponse
object
2 properties 2 required
ModerationModels
string
PoemGenerationModels
string
PoemGenerationRequest
object
2 properties 2 required
PoemGenerationResponse
object
2 properties 2 required
PromptTokensDetails
object
2 properties
QuranReciters
string
STTFormat
string
STTModels
string
STTSegement
object
5 properties 5 required
SafetyFilterRequest
object
3 properties 3 required
SafetyFilterResponse
object
2 properties 2 required
SourcesEnum
string
SpeechToTextResponseJson
object
1 property 1 required
SpeechToTextResponseWithJson-Input
object
2 properties 2 required
SpeechToTextResponseWithJson-Output
object
2 properties 2 required
SpeechToTextResponseWithSRT
object
2 properties 2 required
SpeechToTextResponseWithText
object
2 properties 2 required
TTSModels
string
TTSResponseFormat
string
TextToSpeechRequest
object
7 properties 3 required
TokenizationRequest
object
2 properties 2 required
TokenizationResponse
object
3 properties 3 required
TopLogprob
object
3 properties 2 required
TranslationLangPairs
string
TranslationModels
string
TranslationPreprocessing
string
TranslationRequest
object
4 properties 3 required
TranslationResponse
object
2 properties 2 required
URL
object
1 property 1 required
VideoURL
object
1 property 1 required
Voice
object
7 properties 2 required
VoiceResponse
object
1 property 1 required
TokenChunk
object
5 properties 4 required
ChoiceToken
object
3 properties 1 required
DeltaContent
object
1 property 1 required
ToolCallChunk
object
5 properties 4 required
ChoiceToolCall
object
3 properties 1 required
DeltaToolCalls
object
1 property 1 required
FunctionData
object
Function call details
2 properties 2 required
ToolCallData
object
Tool call in delta.toolcalls
4 properties 3 required
ToolResultChunk
object
5 properties 4 required
ChoiceToolResult
object
3 properties 1 required
DeltaToolResult
object
1 property 1 required
ToolResultData
object
Tool result data
6 properties 1 required
ProgressChunk
object
5 properties 4 required
ProgressData
object
Progress event data
1 property 1 required
ProgressMessage
object
Bilingual progress message
2 properties 2 required
DoneChunk
object
7 properties 4 required
ChoiceFinal
object
3 properties 1 required
DeltaReferences
object
1 property
ErrorChunk
object
Error chunk
5 properties 4 required
ChoiceError
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hbku-fanar-api-openapi.yml Raw ↑

Other APIs Hamad Bin Khalifa University publishes across the network.

Farasa Web API
Elmi Research Portal — OAI-PMH
HBKU Academic Catalog — Course Search
Manara — Qatar Research Repository (HBKU portal)
Where this information came from

This is an independent, third-party profile of Fanar API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.