Channels

Telegram pairing management. Requires channels scope.

List Telegram pairing requests

get

Returns pending Telegram pairing requests for an agent. Requires channels scope.

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

idstring · uuidRequired

Responses

200

List of pairing requests

No content

401

Unauthorized — Invalid or missing API key

application/json

403

Forbidden — Key lacks the required scope

application/json

get

/agents/{id}/channels/telegram/pairing

HTTPcURLJavaScriptPython

GET /api/v1/agents/{id}/channels/telegram/pairing HTTP/1.1
Host: api.guayaba.run
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List approved Telegram pairings

get

Returns approved Telegram pairings for an agent. Requires channels scope.

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

idstring · uuidRequired

Responses

200

List of approved pairings

No content

401

Unauthorized — Invalid or missing API key

application/json

403

Forbidden — Key lacks the required scope

application/json

get

/agents/{id}/channels/telegram/pairing/approved

HTTPcURLJavaScriptPython

GET /api/v1/agents/{id}/channels/telegram/pairing/approved HTTP/1.1
Host: api.guayaba.run
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Approve a Telegram pairing

post

Approves a pending Telegram pairing request. Requires channels scope.

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

idstring · uuidRequired

Body

application/json

codestringRequired

The pairing code shown to the Telegram user

Responses

200

Pairing approved

No content

401

Unauthorized — Invalid or missing API key

application/json

403

Forbidden — Key lacks the required scope

application/json

post

/agents/{id}/channels/telegram/pairing/approve

HTTPcURLJavaScriptPython

POST /api/v1/agents/{id}/channels/telegram/pairing/approve HTTP/1.1
Host: api.guayaba.run
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "code": "text"
}

No content

Revoke a Telegram pairing

post

Revokes an approved Telegram pairing. Requires channels scope.

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

idstring · uuidRequired

Body

application/json

userIdstringRequired

Telegram user ID to revoke

Responses

200

Pairing revoked

No content

401

Unauthorized — Invalid or missing API key

application/json

403

Forbidden — Key lacks the required scope

application/json

post

/agents/{id}/channels/telegram/pairing/revoke

HTTPcURLJavaScriptPython

POST /api/v1/agents/{id}/channels/telegram/pairing/revoke HTTP/1.1
Host: api.guayaba.run
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "userId": "text"
}

No content

Reject a Telegram pairing

post

Rejects a pending Telegram pairing request. Requires channels scope.

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

idstring · uuidRequired

Body

application/json

codestringRequired

The pairing code to reject

Responses

200

Pairing rejected

No content

401

Unauthorized — Invalid or missing API key

application/json

403

Forbidden — Key lacks the required scope

application/json

post

/agents/{id}/channels/telegram/pairing/reject

HTTPcURLJavaScriptPython

POST /api/v1/agents/{id}/channels/telegram/pairing/reject HTTP/1.1
Host: api.guayaba.run
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "code": "text"
}

No content