API:n yleiskatsaus - Macaly Documentation

Macalyn API:n avulla ulkopuoliset sovellukset voivat luoda keskusteluja, rakentaa tekoälyn avulla verkkosovelluksia ja julkaista ne tuotantoon ohjelmallisesti.

Käytettävissä vain Toimisto-paketissa

Perus-URL

https://www.macaly.com

Pikaopas

Hanki API-avain: katso Authentication
Luo keskustelu: lähetä kehote ja aloita rakentaminen
Odota valmistumista: kysele tilaa, kunnes tekoäly on valmis
Julkaise: vie sovelluksesi tuotantoon

Käytettävissä olevat päätepisteet

Metodi	Päätepiste	Kuvaus
POST	`/api/chat`	Luo uusi keskustelu ja aloita rakentaminen
POST	`/api/chat/{chatId}/publish`	Lähetä viesti olemassa olevaan keskusteluun
POST	`/api/client-app/assets/upload`	Lataa tiedosto ja saa pysyvä CDN-osoite
GET	`/api/chat/{chatId}/status`	Kysele työnkulun tilaa
GET	`/api/chat/{chatId}/subscribe`	Tilaa reaaliaikainen virta
POST	`/api/chat/{chatId}/deploy`	Julkaise keskustelu tuotantoon
GET	`/api/chat/{chatId}/deployment`	Hae julkaisun tila

Käyttörajat ja krediitit

API-pyynnöt kuluttavat krediittejä workspacesi saldosta
Keskustelun luominen maksaa saman verran kuin verkkokäyttöliittymässä
Epäonnistuneita API-avaimen tunnistautumisyrityksiä rajoitetaan (5 minuutissa IP-osoitetta kohti)
Seuraa käyttöäsi kohdassa Asetukset → Käyttö ja rajat

Virheiden käsittely

Kaikki virheet palauttavat JSON-vastauksen, jossa on error-kenttä:

{
  "error": "Error message here"
}

HTTP-tilakoodit

Tila	Kuvaus
400	Bad Request: virheellinen pyynnön runko
401	Unauthorized: virheellinen tai puuttuva API-avain
402	Payment Required: krediitit eivät riitä
403	Forbidden: ei oikeuksia tai väärä workspace
404	Not Found: resurssia ei löytynyt
422	Unprocessable Entity: validointivirhe
429	Too Many Requests: käyttöraja ylitetty
500	Internal Server Error: palvelinpuolen virhe
503	Service Unavailable: palvelin on varattu, yritä myöhemmin uudelleen