Catalogs

Read-only reference data (frameworks, regions, hardware, models). Cached 10 min.

List available frameworks

get

Returns all available agent frameworks. Any API key type. Cached 10 min.

Authorizations

PublicApiKey

AuthorizationstringRequired

API key sent as Bearer token. Two types:

• Master key (g_master_...): full access to all agents and endpoints.
• Agent key (g_agent_...): scoped to a single agent with specific permissions.

Responses

200

List of frameworks

application/json

idstring · uuidOptional

slugstringOptionalExample: openclaw

namestringOptionalExample: OpenClaw

descriptionstringOptional

iconstring · nullableOptional

availablebooleanOptional

tagstring · nullableOptional

401

Unauthorized — Invalid or missing API key

application/json

403

Forbidden — Active subscription required

application/json

get

/catalogs/frameworks

HTTPcURLJavaScriptPython

GET /api/v1/catalogs/frameworks HTTP/1.1
Host: api.guayaba.run
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "slug": "openclaw",
    "name": "OpenClaw",
    "description": "text",
    "icon": "text",
    "available": true,
    "tag": "text"
  }
]

List framework clients

get

Returns available clients for a specific framework. Any API key type. Cached 10 min.

Authorizations

PublicApiKey

AuthorizationstringRequired

API key sent as Bearer token. Two types:

• Master key (g_master_...): full access to all agents and endpoints.
• Agent key (g_agent_...): scoped to a single agent with specific permissions.

Path parameters

frameworkIdstringRequired

Responses

200

List of framework clients

No content

401

Unauthorized — Invalid or missing API key

application/json

403

Forbidden — Active subscription required

application/json

get

/catalogs/frameworks/{frameworkId}/clients

HTTPcURLJavaScriptPython

GET /api/v1/catalogs/frameworks/{frameworkId}/clients HTTP/1.1
Host: api.guayaba.run
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List available regions

get

Returns all available deployment regions. Any API key type. Cached 10 min.

Authorizations

PublicApiKey

AuthorizationstringRequired

API key sent as Bearer token. Two types:

• Master key (g_master_...): full access to all agents and endpoints.
• Agent key (g_agent_...): scoped to a single agent with specific permissions.

Responses

200

List of regions

application/json

idstring · uuidOptional

slugstringOptionalExample: eu-central-1

labelstringOptionalExample: EU (Frankfurt)

citystringOptionalExample: Frankfurt

availablebooleanOptional

401

Unauthorized — Invalid or missing API key

application/json

403

Forbidden — Active subscription required

application/json

get

/catalogs/regions

HTTPcURLJavaScriptPython

GET /api/v1/catalogs/regions HTTP/1.1
Host: api.guayaba.run
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "slug": "eu-central-1",
    "label": "EU (Frankfurt)",
    "city": "Frankfurt",
    "coords": {
      "lat": 1,
      "lng": 1
    },
    "available": true
  }
]

List available hardware configs

get

Returns all available hardware configurations. Any API key type. Cached 10 min.

Authorizations

PublicApiKey

AuthorizationstringRequired

API key sent as Bearer token. Two types:

• Master key (g_master_...): full access to all agents and endpoints.
• Agent key (g_agent_...): scoped to a single agent with specific permissions.

Responses

200

List of hardware configs

No content

401

Unauthorized — Invalid or missing API key

application/json

403

Forbidden — Active subscription required

application/json

get

/catalogs/hardware

HTTPcURLJavaScriptPython

GET /api/v1/catalogs/hardware HTTP/1.1
Host: api.guayaba.run
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List available models

get

Returns all available AI models. Any API key type. Cached 10 min.

Authorizations

PublicApiKey

AuthorizationstringRequired

API key sent as Bearer token. Two types:

• Master key (g_master_...): full access to all agents and endpoints.
• Agent key (g_agent_...): scoped to a single agent with specific permissions.

Responses

200

List of models

application/json

idstring · uuidOptional

model_idstringOptionalExample: anthropic/claude-sonnet-4.6

providerstringOptionalExample: openrouter

namestringOptionalExample: Claude Sonnet 4.6

descriptionstring · nullableOptional

is_freebooleanOptional

is_defaultbooleanOptional

401

Unauthorized — Invalid or missing API key

application/json

403

Forbidden — Active subscription required

application/json

get

/catalogs/models

HTTPcURLJavaScriptPython

GET /api/v1/catalogs/models HTTP/1.1
Host: api.guayaba.run
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "model_id": "anthropic/claude-sonnet-4.6",
    "provider": "openrouter",
    "name": "Claude Sonnet 4.6",
    "description": "text",
    "is_free": true,
    "is_default": true
  }
]