> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arnio.co/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Arnio API Reference

<div className="rounded-lg border border-neutral-800 bg-neutral-900 p-6 mb-10">
  <p className="text-neutral-300">
    Welcome to the <b>Arnio API</b> 🚀<br />
    Use this API to send messages, manage contacts, and automate workflows.<br />
    All endpoints require an <b>API key</b> for authentication.
  </p>
</div>

# Contacts

## <a href="/api-reference/endpoint/contacts/get-contact" className="no-underline text-inherit">Get contacts</a>

<span className="inline-flex items-center rounded-md border border-green-500/40 bg-green-500/10 px-2 py-0.5 text-xs font-medium text-green-400">GET</span> `/api/v1/contacts`

## <a href="/api-reference/endpoint/contacts/create-contact" className="no-underline text-inherit">Create contact</a>

<span className="inline-flex items-center rounded-md border border-blue-500/40 bg-blue-500/10 px-2 py-0.5 text-xs font-medium text-blue-400">POST</span> `/api/v1/contacts`

## <a href="/api-reference/endpoint/contacts/get-contact" className="no-underline text-inherit">Get contact</a>

<span className="inline-flex items-center rounded-md border border-green-500/40 bg-green-500/10 px-2 py-0.5 text-xs font-medium text-green-400">GET</span> `/api/v1/contacts/{id}`

## <a href="/api-reference/endpoint/contacts/delete-contact" className="no-underline text-inherit">Delete contact</a>

<span className="inline-flex items-center rounded-md border border-red-500/40 bg-red-500/10 px-2 py-0.5 text-xs font-medium text-red-400">DELETE</span> `/api/v1/contacts/{id}`

## <a href="/api-reference/endpoint/contacts/contact-messages" className="no-underline text-inherit">Get contact messages</a>

<span className="inline-flex items-center rounded-md border border-green-500/40 bg-green-500/10 px-2 py-0.5 text-xs font-medium text-green-400">GET</span> `/api/v1/contacts/{id}/messages`

## <a href="/api-reference/endpoint/contacts/get-contact-message-attachment" className="no-underline text-inherit">Get contact attachment</a>

<span className="inline-flex items-center rounded-md border border-green-500/40 bg-green-500/10 px-2 py-0.5 text-xs font-medium text-green-400">GET</span> `/api/v1/contacts/{id}/attachments/{guid}`

***

# Messages

## <a href="/api-reference/endpoint/messages/send-message" className="no-underline text-inherit">Send message</a>

<span className="inline-flex items-center rounded-md border border-blue-500/40 bg-blue-500/10 px-2 py-0.5 text-xs font-medium text-blue-400">POST</span> `/api/v1/messages/send`

## <a href="/api-reference/endpoint/messages/get-messages" className="no-underline text-inherit">Get messages</a>

<span className="inline-flex items-center rounded-md border border-green-500/40 bg-green-500/10 px-2 py-0.5 text-xs font-medium text-green-400">GET</span> `/api/v1/messages`

## <a href="/api-reference/endpoint/messages/get-message-attachment" className="no-underline text-inherit">Get attachment</a>

<span className="inline-flex items-center rounded-md border border-green-500/40 bg-green-500/10 px-2 py-0.5 text-xs font-medium text-green-400">GET</span> `/api/v1/messages/attachments/{guid}`

## <a href="/api-reference/endpoint/messages/check-imessage-availability.mdx" className="no-underline text-inherit">iMessage availability</a>

<span className="inline-flex items-center rounded-md border border-green-500/40 bg-green-500/10 px-2 py-0.5 text-xs font-medium text-green-400">GET</span> `/api/v1/imessage/availability`

## <a href="/api-reference/endpoint/messages/delete-chat" className="no-underline text-inherit">Delete a chat</a>

<span className="inline-flex items-center rounded-md border border-red-500/40 bg-red-500/10 px-2 py-0.5 text-xs font-medium text-red-400">DELETE</span> `/api/v1/chats/{chatGuid}`

***

# Webhooks

## <a href="/api-reference/endpoint/webhooks/create-webhook" className="no-underline text-inherit">Create webhook</a>

<span className="inline-flex items-center rounded-md border border-blue-500/40 bg-blue-500/10 px-2 py-0.5 text-xs font-medium text-blue-400">POST</span> `/api/v1/webhooks`

## <a href="/api-reference/endpoint/webhooks/update-webhook" className="no-underline text-inherit">Update webhook</a>

<span className="inline-flex items-center rounded-md border border-orange-500/40 bg-orange-500/10 px-2 py-0.5 text-xs font-medium text-orange-400">PUT</span> `/api/v1/webhooks/{webhookId}`

## <a href="/api-reference/endpoint/webhooks/get-webhooks" className="no-underline text-inherit">Get webhooks</a>

<span className="inline-flex items-center rounded-md border border-green-500/40 bg-green-500/10 px-2 py-0.5 text-xs font-medium text-green-400">GET</span> `/api/v1/webhooks`

## <a href="/api-reference/endpoint/webhooks/delete-webhook" className="no-underline text-inherit">Delete webhook</a>

<span className="inline-flex items-center rounded-md border border-red-500/40 bg-red-500/10 px-2 py-0.5 text-xs font-medium text-red-400">DELETE</span> `/api/v1/webhooks/{webhookId}`

***

# Webhook Events

Webhook sends various events related to messaging actions. The following events are supported:

### Event Types:

* **`message.created`**: Triggered when a new message is received or sent.
  * Example: A new incoming or outgoing message has been created.
* **`message.updated`**: Triggered when an existing message's status is updated.
  * Example: A read receipt or delivery status for a message is updated.
* **`typing-indicator`**: Triggered when a typing indicator is received.
  * Example: The user starts typing in the conversation.

These webhook events help you track interactions such as message sending, status updates, typing indicators, and more in real-time.