Getting started

API Reference

Integrate with Nebux services from your own applications

Overview

The Nebux API lets you interact with all Nebux services programmatically. Most operations are exposed via a single GraphQL endpoint; the AI inference service additionally offers an OpenAI-compatible REST API.

GraphQL endpoint

URL

https://api.nebux.cloud

MethodPOST

Content-Typeapplication/json

Authentication

All requests must include a valid API key as a Bearer token in the Authorization header. A key holds exactly the permissions it was granted, and anything outside them answers as if it did not exist. You can manage your API keys and what each one may do from the dashboard.

HeaderAuthorization: Bearer your-api-key

API keysManage API keys

Request format

GraphQL requests are JSON objects with a query field (the GraphQL document) and an optional variables field.

body.json

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

Making a request

The Nebux GraphQL API works with any HTTP client. No special library is required — just send a POST request with a JSON body. The examples below show how to make a simple query in your project's language.

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)

Tip: If you prefer a typed GraphQL client, libraries such as graphql-request (JS/TS) or gql (Python) work out of the box with this endpoint.