Pular para o conteúdo principal

API Reference

This section documents the Appilots HTTP API — the surface you call directly if you're building a custom client, a server-side integration, or automated tooling rather than using the SDK. If you're integrating a React Native app, you'll usually want the SDK instead; the SDK calls these same endpoints for you.

Base URL​

All requests in this section are made against:

https://api.appilots.com

Versioning​

Every route is prefixed with /api/v1. For example, creating a session is:

POST https://api.appilots.com/api/v1/agent/session

Authentication​

Every route documented in this section requires an API key sent as a bearer token. See Authentication for the full requirement and how to obtain a key.

Response envelope​

Every response is JSON with a consistent shape.

Success:

{
  "success": true,
  "data": { ... }
}

Failure:

{
  "success": false,
  "error": {
    "code": "STRING_CODE",
    "message": "Human-readable description"
  }
}

The HTTP status code reflects the outcome (2xx for success, 4xx/5xx for failure). See Errors for the full list of error codes.

Request correlation​

Every response carries an X-Request-Id response header. You can also send your own X-Request-Id request header — the server echoes back the same value — which is useful for correlating a request across your logs and Appilots' when reporting an issue.

What's covered here vs. the dashboard​

This section documents the routes authenticated by API key — session and message handling, actions, user identification, and human escalation, plus the appilots CLI's sync endpoint. Project setup, API key management, permission and budget configuration, webhook configuration, usage analytics, and human escalation operator tooling are all dashboard workflows rather than API routes; see Dashboard: Projects & API keys and the rest of the Dashboard section for those.

Health check​

GET /api/v1/health

A plain connectivity check — no authentication required. Returns 200 if the API is up. The appilots CLI uses this during init and other connectivity checks; you can use it the same way to verify reachability before debugging further.

curl

curl https://api.appilots.com/api/v1/health
Última atualização em