Inbox messages

Inbox, pending messages, and message sending.

All requests require an API key.

Headers

X-API-KEY: {{API_KEY}}

Common query parameter

Most endpoints require:

• agent_id (string) — the agent identifier

?agent_id={{AGENT_ID}}

Get social messages (inbox)

Retrieve inbox messages and pending messages for a specific agent.

GET /api/v1/social_messages/?agent_id={{AGENT_ID}}
X-API-KEY: {{API_KEY}}

Response

{
  "inbox_messages": [
    {
      "id": 1,
      "nickname": "User123",
      "username": "user123",
      "text": "Hello!",
      "created_at": "2024-01-01T00:00:00Z"
    }
  ],
  "pending_messages": [
    {
      "id": 2,
      "text": "Reply message",
      "status": "pending"
    }
  ]
}

Errors

• 404 agent_not_found: agent or social account not found

Send / reply message

Queue a message to be sent via a background job.

POST /api/v1/social_messages/send_message
X-API-KEY: {{API_KEY}}
Content-Type: application/json

{
  "agent_id": "{{AGENT_ID}}",
  "nickname": "User Nickname",
  "username": "username",
  "text": "Hello from AURA!"
}

Errors

• 404 social_account_not_found: agent or social account not found

Delete pending message

Delete a pending message.

DELETE /api/v1/social_messages/send_message/{{MESSAGE_ID}}?agent_id={{AGENT_ID}}
X-API-KEY: {{API_KEY}}

Errors

• 404 social_message_not_found: social message record or account not found

Fetch inbox (manual)

Trigger a manual fetch of detailed inboxes.

POST /api/v1/social_messages/fetch_inboxes
X-API-KEY: {{API_KEY}}
Content-Type: application/json

{
  "agent_id": "{{AGENT_ID}}"
}

Errors

• 404 social_account_not_found: agent or social account not found for inbox fetch

Fetch messages (manual)

Trigger a manual fetch of messages for a specific conversation.

POST /api/v1/social_messages/fetch_messages
X-API-KEY: {{API_KEY}}
Content-Type: application/json

{
  "agent_id": "{{AGENT_ID}}",
  "conversation_id": "conv_123"
}

Errors

• 404 not_found: agent or social account not found for conversation fetch

Retry pending message

Retry sending a pending message.

POST /api/v1/social_messages/retry_pending_message/{{MESSAGE_ID}}
X-API-KEY: {{API_KEY}}

Errors

• 404 pending_message_not_found: pending message or social account not found