> ## Documentation Index
> Fetch the complete documentation index at: https://www.macaly.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# API:n yleiskatsaus

> Rakenna ja julkaise verkkosovelluksia ohjelmallisesti Macalyn API:n avulla

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

<Callout icon="user">
  Käytettävissä vain [**Toimisto-paketissa**](/docs/fi/welcome/pricing)
</Callout>

## Perus-URL

```
https://www.macaly.com
```

## Pikaopas

1. **Hanki API-avain**: katso [Authentication](/docs/fi/api/authentication)
2. **Luo keskustelu**: lähetä kehote ja aloita rakentaminen
3. **Odota valmistumista**: kysele tilaa, kunnes tekoäly on valmis
4. **Julkaise**: vie sovelluksesi tuotantoon

## Käytettävissä olevat päätepisteet

| Metodi | Päätepiste | Kuvaus |
| - | - | - |
| POST | [`/api/chat`](/docs/fi/api/create-chat) | Luo uusi keskustelu ja aloita rakentaminen |
| POST | [`/api/chat/{chatId}/publish`](/docs/fi/api/publish-message) | Lähetä viesti olemassa olevaan keskusteluun |
| POST | [`/api/client-app/assets/upload`](/docs/fi/api/upload-asset) | Lataa tiedosto ja saa pysyvä CDN-osoite |
| GET | [`/api/chat/{chatId}/status`](/docs/fi/api/get-status) | Kysele työnkulun tilaa |
| GET | [`/api/chat/{chatId}/subscribe`](/docs/fi/api/subscribe-stream) | Tilaa reaaliaikainen virta |
| POST | [`/api/chat/{chatId}/deploy`](/docs/fi/api/deploy) | Julkaise keskustelu tuotantoon |
| GET | [`/api/chat/{chatId}/deployment`](/docs/fi/api/get-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ä:

```json theme={null}
{
  "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 |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.