Primers passos

Referència de l'API

Integra els serveis de Nebux en les teues aplicacions

Visió general

L'API de Nebux et permet interactuar amb tots els serveis de Nebux programàticament. La majoria d'operacions s'exposen a través d'un únic punt d'accés GraphQL; el servei d'inferència d'IA oferix addicionalment una API REST compatible amb OpenAI.

Punt d'accés GraphQL

URL

https://api.nebux.cloud

MethodPOST

Content-Typeapplication/json

Autenticació

Totes les peticions han d'incloure una clau d'API vàlida com a token Bearer en la capçalera Authorization. Una clau té exactament els permisos que se li han concedit, i tot el que en queda fora respon com si no existira. Pots gestionar les teues claus d'API i el que pot fer cadascuna des del tauler.

HeaderAuthorization: Bearer your-api-key

API keysGestiona les claus d'API

Format de la petició

Les peticions GraphQL són objectes JSON amb un camp query (el document GraphQL) i un camp variables opcional.

body.json

{
  "query": "query GetIssue($id: ID!) { issue(id: $id) { id friendlyId title status } }",
  "variables": { "id": "rprdbtyvc51ys7g7xq9xwra8cm" }
}

Fer una petició

L'API GraphQL de Nebux funciona amb qualsevol client HTTP. No cal cap biblioteca especial — simplement envia una petició POST amb un cos JSON. Els exemples de baix mostren com fer una consulta senzilla en el llenguatge del teu projecte.

index.ts

const res = await fetch("https://api.nebux.cloud", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer your-api-key",
  },
  body: JSON.stringify({
    query: `query GetIssue($id: ID!) { issue(id: $id) { id friendlyId title status } }`,
    variables: { id: "rprdbtyvc51ys7g7xq9xwra8cm" },
  }),
})

const { data } = await res.json()
console.log(data.issue.title)

Consell: Si preferixes un client GraphQL tipat, biblioteques com graphql-request (JS/TS) o gql (Python) funcionen directament amb este punt d'accés.