# Reve Art API Documentation
Reve Art API-ka soo dhaweeyey. Adeeggu waxa uu bixiyaa awoodda jiilka sawirada ee AI-ku ku shaqeeyo ee leh API REST fudud.
## Hordhac Reve Image 1.0
Reve Image 1.0 waa moodelkeena jiilka qoraal-ilaa-sawirka ee ugu hormarsan, oo loogu talagalay diiradda:
- U hogaansamida degdega ah ee sareeya
- Tayada quruxda sare
- Bixinta nooca saxda ah
- Jiilka qoraal-ilaa-sawirka oo dareen leh
Moodelka waxa loogu talagalay inuu soo saaro natiijooyin tayo sare leh iyadoo aan loo baahnayn aqoonta horumarsan ee injineernimada degdega ah, taas oo ka dhigaysa mid la heli karo bilowgii iyo isticmaalayaasha khibradda lehba. Waxaad isku dayi kartaa lacag la'aan [Create Image](https://reve-art.com/dashboard/create).
## Isticmaalka Kiisaska
Reve Art API waxa lagu dhex dari karaa codsiyo kala duwan:
- Abuurista Waxyaabaha: Soo saar muuqaalo gaar ah oo loogu talagalay blogs, maqaallo, iyo warbaahinta bulshada
- E-commerce: Abuur alaabta moodeelka iyo kala duwanaanshaha
- Naqshadeynta & Prototyping: Si degdeg ah u arag fikradaha naqshadeynta
- Gaming & Entertainment: Soo saar hantida ciyaarta iyo naqshadeynta jilayaasha
- Waxbarashada: Abuur qalab waxbarasho iyo sawirro
## Xaqiijinta
Dhammaan codsiyada API waxay u baahan yihiin xaqiijin iyadoo la isticmaalayo furaha API.
Ku dar furaha API cinwaanka Xaqiijinta:
bash
curl -X POST https://reve-art.com/v1/reve-image/generate
-H "Authorization: Bearer your_api_key"
-H "Content-Type: application/json"
-d '{"prompt": "your prompt here", "aspect_ratio": "1:1"}'
## Sidee loo helaa Furaha API
Fadlan soo gal oo ku dar api-key-gaaga bogga [Dashboard > API Key](/dashboard/api-keys).
Kadib isticmaal api-key si aad sawirro u dhaliso.
## Soo saar Sawir
Goobta jiilka sawirka waxay kuu ogolaaneysaa inaad sawirro ka abuurto sharraxaad qoraal ah. Waxaad xakameyn kartaa dhinacyo kala duwan oo ka mid ah habka jiilka iyada oo loo marayo xuduudaha.
### Dhaqamada Ugu Wanaagsan
1. **Injineerinta Degdega ah**
- Noqo mid gaar ah oo sharraxaya degdegaaga
- Isticmaal ereyada farshaxanka ee hagitaanka qaabka
- Ku dar faahfaahin ku saabsan iftiinka, aragtida, iyo niyadda
2. **Xulashada Qeybta Aragtida**
- Dooro iyada oo ku saleysan kiiska isticmaalka loogu talagalay
- 1:1 ee boostada warbaahinta bulshada
- 16:9 ee soo bandhigida/calanka
- 9:16 ee waxa ku jira mobilada
3. **Jiilka Async**
- Isticmaal async=true ee jiilka dheer
- Hirgeli codbixinta xaalada si loo helo waayo-aragnimo isticmaale oo wanaagsan
### POST /v1/images/generate
#### Jirka Codsiga
```json
{
"prompt": "string", // Looma baahna: Dhiirigelinta jiilka sawirka
"negative_prompt": "string", // Ikhtiyaari: Waxyaabaha laga fogaanayo sawirka
"aspect_ratio": "string", // Looma baahna: Qeybta aragtida sawirka (default: "1:1")
"async": boolean // Ikhtiyaari: Jiilka Async (default: false)
}
Qeybta Aragtida
Qeybta aragtida ee sawirka. Qiyaasaha la taageeray: "1:1", "16:9", "4:3", "3:4", "9:16", "2:3", "3:2".
Jawaabta Isku mar
{
"id": "img_123",
"status": "completed",
"url": "https://cdn.reve-art.com/img_123.png",
"metadata": {
"prompt": "your prompt",
"width": 1024,
"height": 1024,
"created_at": "2024-01-01T00:00:00Z"
}
}
Jawaabta Asynchronous
{
"id": "img_123",
"status": "pending"
}
Tusaale Isticmaalka
Python:
import requests
api_key = "your_api_key"
headers = {
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json"
}
response = requests.post(
"https://api.reve-art.com/v1/reve-image/generate",
headers=headers,
json={
"prompt": "a beautiful sunset over mountains",
"aspect_ratio": "16:9"
}
)
if response.ok:
result = response.json()
print(f"Image URL: {result['url']}")
else:
print(f"Error: {response.text}")
Node.js:
async function generateImage(prompt: string) {
const response = await fetch("https://api.reve-art.com/v1/reve-image/generate", {
method: "POST",
headers: {
"Authorization": `Bearer ${apiKey}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
prompt,
aspect_ratio: "1:1",
async: true,
}),
});
if (!response.ok) {
throw new Error(`Failed to generate image: ${response.statusText}`);
}
const result = await response.json();
if (result.status === "pending") {
// Poll for completion
return await checkImageStatus(result.id);
}
return result;
}
Hubi Xaaladda Sawirka
GET /v1/reve-image/status/image_id
Jawaab
{
"id": "img_123",
"status": "completed",
"url": "https://cdn.reve-art.com/img_123.png",
"metadata": {
"prompt": "original prompt",
"width": 1024,
"height": 1024,
"model": "text2image_v1",
"created_at": "2024-01-01T00:00:00Z"
}
}
Tusaale Isticmaalka
async function checkImageStatus(imageId: string) {
const response = await fetch(
`https://reve-art.com/v1/reve-image/status/${imageId}/`,
{
headers: {
"Authorization": `Bearer ${apiKey}`,
},
}
);
if (!response.ok) {
throw new Error(`Failed to check status: ${response.statusText}`);
}
return await response.json();
}
Xaddidaadda Qiimaha
Codsiyada API waxaa xaddidaayo qorshahaaga rukunka iyo credit-ka aad haysato.
- Jiil kasta oo sawirka ah wuxuu ku kacaa 1 credit
- Qorshaha bilaashka ah: 3 credits oo lagu daray
- Qorshaha aasaasiga ah: 100 credits bishii
- Xaddidaadda qiimaha: 10 codsi daqiiqadii
- Haddii aad u baahan tahay credits dheeraad ah, fadlan horumariso qorshahaaga ama iibso credits dheeraad ah.