Создать API-ключ | Agent Inbox

from agent_inbox import Agentinbox
client = Agentinbox(
    api_key="YOUR_API_KEY_HERE",
)
client.pods.api_keys.create(
    pod_id="pod_id",
)

{
  "api_key_id": "api_key_id",
  "api_key": "api_key",
  "prefix": "prefix",
  "name": "name",
  "created_at": "2024-01-15T09:30:00Z",
  "pod_id": "pod_id",
  "inbox_id": "inbox_id",
  "permissions": {
    "inbox_read": true,
    "inbox_create": true,
    "inbox_update": true,
    "inbox_delete": true,
    "thread_read": true,
    "thread_delete": true,
    "message_read": true,
    "message_send": true,
    "message_update": true,
    "label_spam_read": true,
    "label_blocked_read": true,
    "label_trash_read": true,
    "draft_read": true,
    "draft_create": true,
    "draft_update": true,
    "draft_delete": true,
    "draft_send": true,
    "webhook_read": true,
    "webhook_create": true,
    "webhook_update": true,
    "webhook_delete": true,
    "domain_read": true,
    "domain_create": true,
    "domain_update": true,
    "domain_delete": true,
    "list_entry_read": true,
    "list_entry_create": true,
    "list_entry_delete": true,
    "metrics_read": true,
    "api_key_read": true,
    "api_key_create": true,
    "api_key_delete": true,
    "pod_read": true,
    "pod_create": true,
    "pod_delete": true
  }
}

CLI:

$ agentinbox pods:api-keys create --pod-id <pod_id> --name "My Key"

**CLI:** ```bash agentinbox pods:api-keys create --pod-id <pod_id> --name "My Key" ```

Authentication

AuthorizationBearer

Header authentication of the form Bearer <token>

Path parameters

pod_idstringRequired

Идентификатор пода.

Request

This endpoint expects an object.

namestringOptional

Имя API-ключа.

permissionsobjectOptional

Гранулярные разрешения API-ключа. Если не указано — выдаются все разрешения. Иначе действуют только разрешения со значением true.

Response

This endpoint returns an object.

api_key_idstring

Идентификатор API-ключа.

api_keystring

Секретное значение API-ключа.

prefixstring

Префикс API-ключа.

namestring

Имя API-ключа.

created_atdatetime

Время создания API-ключа.

pod_idstring

Идентификатор пода области действия ключа.

inbox_idstring

Идентификатор ящика области действия ключа.

permissionsobject

Errors

400

Validation Error

404

Not Found Error