Hop til hovedindhold

API-brug

Lær at bruge API-nøgler til at køre apps programmatisk.

Adgang​

  • Udvikler, Anmelder, Administrator: Kan oprette og bruge API-nøgler

Forudsætninger​

  • En aktiv API-nøgle (se API-nøgler)
  • En publiceret app du har adgang til

Kør app via API​

Endpoint​

POST /api/v1/apps/{app_id}/run

Headers​

Authorization: Bearer sk_din_api_nøgle
Content-Type: application/json

Request body​

{
  "inputs": {
    "input_felt_1": "værdi",
    "input_felt_2": 123
  }
}

Response​

{
  "execution_id": "uuid",
  "status": "completed",
  "outputs": {
    "output_felt": "resultat"
  }
}

Streaming-kørsel​

For at modtage real-time opdateringer under kørsel:

Endpoint​

POST /api/v1/apps/{app_id}/run-stream

Headers​

Authorization: Bearer sk_din_api_nøgle
Accept: text/event-stream
Content-Type: application/json

SSE Events​

Du modtager følgende event-typer:

EventBeskrivelse
node_startEn node starter
node_completeEn node er færdig
node_errorEn node fejlede
flow_completeHele flowet er færdigt
flow_errorFlowet fejlede

Begrænsninger​

API-nøgler kan kun bruges til at køre apps. De kan ikke:

  • Liste flows
  • Oprette flows
  • Liste apps
  • Oprette apps
  • Ændre brugerdata

Fejlhåndtering​

HTTP StatusBetydning
401Ugyldig eller tilbagekaldt API-nøgle
403Ingen adgang til appen
404App ikke fundet
422Ugyldig input
500Serverfejl

Eksempel med cURL​

curl -X POST "https://din-server.dk/api/v1/apps/{app_id}/run" \
  -H "Authorization: Bearer sk_din_api_nøgle" \
  -H "Content-Type: application/json" \
  -d '{"inputs": {"tekst": "Hej verden"}}'

Eksempel med Python​

import requests

response = requests.post(
    "https://din-server.dk/api/v1/apps/{app_id}/run",
    headers={
        "Authorization": "Bearer sk_din_api_nøgle",
        "Content-Type": "application/json"
    },
    json={"inputs": {"tekst": "Hej verden"}}
)

result = response.json()
print(result["outputs"])

Relaterede sider​