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

> ## Agent Instructions
> - Base URLs: models `https://api.aisa.one/v1` (Gemini GenerateContent: `https://api.aisa.one/v1beta`); data APIs `https://api.aisa.one/apis/v1`. The `servers` of each operation in https://aisa.one/openapi.yaml is authoritative.
> - Auth: `Authorization: Bearer $AISA_API_KEY`. Never print, log, or commit the key.
> - MCP (preferred for agents): `https://mcp.aisa.one/mcp`, signed in with OAuth, so there is no key to paste.
> - Agent Skill: `npx skills add AIsa-team/agent-skills --skill aisa`. Fallback with the AIsa CLI: `aisa skills install aisa`.
> - Spending: docs, https://aisa.one/models, https://aisa.one/api, `/v1/models`, and MCP `search`, `list_categories`, `get_details`, `batch_quote`, and the `account` operation are free. Quote the exact calls before running them (MCP `batch_quote`, CLI `aisa quote --json`). If the quote reports `auto_execute_eligible: true`, run it unless the user set a tighter limit or asked only for a quote. Otherwise, tell the user in one message the planned calls, the quoted price, and a total USD budget for the task, then wait for approval. Direct HTTP calls follow the stricter rule at https://aisa.one/docs/get-started/cli.md#direct-http-fallback. Do not make paid calls to test availability. Full rule: https://aisa.one/llms.txt

# Search conversations

> Inbox. Read only; needs social:read. Ids are yours: accounts acc_..., profiles prf_..., posts pst_...; every other object id is checked against your accounts before the call. Without profileId or accountId it reads your default profile. On a profile with an X account, pass accountId or a platform other than twitter: X bills each read.

Search your conversations two ways at once, and get back the matching conversations, most-recent match first.

### Message text

Matches words inside message bodies. Case-insensitive and accent-insensitive, exact tokens only (no substrings, no stemming). Each hit carries up to 3 most-recent matching messages.

With direction=outgoing you can collect examples of how you write to customers, for example to teach an AI agent your tone of voice.

### Contact identity

Matches the participant's name, username, or phone number as a case-insensitive substring. These hits have matchCount 0 and an empty matches array.

A conversation that matches both ways is returned once, carrying its message matches.

### Searchable platforms

Only platforms whose messages are stored by AIsa are searchable: WhatsApp, SMS, Telegram, Facebook, Instagram, X and Reddit.

Bluesky conversations are fetched live from the platform and cannot be searched; those accounts are listed in meta.accountsSkipped.

<!-- aisa-pricing:start -->
A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.
<!-- aisa-pricing:end -->

## Request contract

* **Method and path:** GET /apis/v1/social/inbox/conversations/search
* **Availability:** enabled
* **Request URL template:** `https://api.aisa.one/apis/v1/social/inbox/conversations/search`
* **query:** query; required
* **direction:** query; optional
* **profileId:** query; optional
* **platform:** query; optional
* **accountId:** query; optional
* **limit:** query; optional
* **cursor:** query; optional
* **Runtime facts:** 99acb5bddbedc8d3352e7c4fef86c3e6d8852c14772bcd18dbcf415237a642bd

[Complete OpenAPI definition](https://aisa.one/docs/reference-contracts/aisa-social.json)

Effective request and pricing declaration (including authentication and referenced schemas):

```json theme={null}
{
  "operationId": "get_aisa_social_apis_v1_social_inbox_conversation_a94af9",
  "method": "GET",
  "path": "/apis/v1/social/inbox/conversations/search",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [
    {
      "description": "Text to search for, in message content and in the contact's name, username, or phone number",
      "in": "query",
      "name": "query",
      "required": true,
      "schema": {
        "maxLength": 200,
        "minLength": 2,
        "type": "string"
      }
    },
    {
      "description": "Only match messages sent to you (incoming) or by you (outgoing). Contact-identity matching is not applied when this is set.",
      "in": "query",
      "name": "direction",
      "required": false,
      "schema": {
        "enum": [
          "incoming",
          "outgoing"
        ],
        "type": "string"
      }
    },
    {
      "description": "One of your profiles (prf_...). Defaults to your default profile when neither profileId nor accountId is sent.",
      "in": "query",
      "name": "profileId",
      "required": false,
      "schema": {
        "pattern": "^prf_[0-9A-Za-z]{22}$",
        "type": "string"
      }
    },
    {
      "description": "Filter by platform (searchable platforms only)",
      "in": "query",
      "name": "platform",
      "required": false,
      "schema": {
        "enum": [
          "facebook",
          "instagram",
          "telegram",
          "whatsapp",
          "sms",
          "rcs",
          "slack",
          "imessage"
        ],
        "type": "string"
      }
    },
    {
      "description": "One of your social accounts (acc_...).",
      "in": "query",
      "name": "accountId",
      "required": false,
      "schema": {
        "pattern": "^acc_[0-9A-Za-z]{22}$",
        "type": "string"
      }
    },
    {
      "description": "Maximum number of conversations to return",
      "in": "query",
      "name": "limit",
      "required": false,
      "schema": {
        "default": 20,
        "maximum": 50,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "description": "Opaque pagination cursor. Pass back pagination.nextCursor verbatim; do not construct one.",
      "in": "query",
      "name": "cursor",
      "required": false,
      "schema": {
        "type": "string"
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-aisa-status": "enabled",
  "x-aisa-pricing": {
    "description": "Included with your connected social accounts: AIsa does not charge per call.",
    "kind": "no_customer_charge"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}
```

## Cost and request rules

A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.

Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.


## OpenAPI

````yaml reference-contracts/aisa-social.json GET /apis/v1/social/inbox/conversations/search
openapi: 3.1.0
info:
  description: ''
  title: AIsa Social
  version: '1'
  x-aisa-capabilities:
    idempotency: Idempotency-Key
    max_price: X-AISA-Max-Price-USD
    quote:
      header: X-AISA-Cost-Mode
      value: quote
  x-aisa-configured-paths: []
  x-aisa-document:
    facts_hash: 99acb5bddbedc8d3352e7c4fef86c3e6d8852c14772bcd18dbcf415237a642bd
    generator_version: '3'
    protocol_version: '1'
    schema_version: '1'
    composer_version: '27'
    response_pending: []
    document_hash: sha256:7f9742cb1ea233c648dcb290fdfbf24e53a27dcf900ec1386f83a8ef2e6b1bf9
  x-aisa-plans:
    builder: 1
    display_plan: payg
    payg: 1
    similarweb_payg: 1
    team: 1
    version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb
  x-aisa-provider: aisa-social
  x-aisa-catalogs:
    aisa-social:
      title: AIsa Social
      description: ''
      x-aisa-document:
        facts_hash: 99acb5bddbedc8d3352e7c4fef86c3e6d8852c14772bcd18dbcf415237a642bd
        generator_version: '3'
        protocol_version: '1'
        schema_version: '1'
      x-aisa-plans:
        builder: 1
        display_plan: payg
        payg: 1
        similarweb_payg: 1
        team: 1
        version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb
      x-aisa-capabilities:
        idempotency: Idempotency-Key
        max_price: X-AISA-Max-Price-USD
        quote:
          header: X-AISA-Cost-Mode
          value: quote
servers:
  - url: https://api.aisa.one
security:
  - bearerAuth: []
paths:
  /apis/v1/social/inbox/conversations/search:
    get:
      summary: Search conversations
      description: >-
        Inbox. Read only; needs social:read. Ids are yours: accounts acc_...,
        profiles prf_..., posts pst_...; every other object id is checked
        against your accounts before the call. Without profileId or accountId it
        reads your default profile. On a profile with an X account, pass
        accountId or a platform other than twitter: X bills each read.


        Search your conversations two ways at once, and get back the matching
        conversations, most-recent match first.


        ### Message text


        Matches words inside message bodies. Case-insensitive and
        accent-insensitive, exact tokens only (no substrings, no stemming). Each
        hit carries up to 3 most-recent matching messages.


        With direction=outgoing you can collect examples of how you write to
        customers, for example to teach an AI agent your tone of voice.


        ### Contact identity


        Matches the participant's name, username, or phone number as a
        case-insensitive substring. These hits have matchCount 0 and an empty
        matches array.


        A conversation that matches both ways is returned once, carrying its
        message matches.


        ### Searchable platforms


        Only platforms whose messages are stored by AIsa are searchable:
        WhatsApp, SMS, Telegram, Facebook, Instagram, X and Reddit.


        Bluesky conversations are fetched live from the platform and cannot be
        searched; those accounts are listed in meta.accountsSkipped.


        <!-- aisa-pricing:start -->

        A request reference price is not currently available; use a request
        quote where supported. Account-specific pricing and final settlement may
        differ.

        <!-- aisa-pricing:end -->
      operationId: get_aisa_social_apis_v1_social_inbox_conversation_a94af9
      parameters:
        - description: >-
            Text to search for, in message content and in the contact's name,
            username, or phone number
          in: query
          name: query
          required: true
          schema:
            maxLength: 200
            minLength: 2
            type: string
        - description: >-
            Only match messages sent to you (incoming) or by you (outgoing).
            Contact-identity matching is not applied when this is set.
          in: query
          name: direction
          required: false
          schema:
            enum:
              - incoming
              - outgoing
            type: string
        - description: >-
            One of your profiles (prf_...). Defaults to your default profile
            when neither profileId nor accountId is sent.
          in: query
          name: profileId
          required: false
          schema:
            pattern: ^prf_[0-9A-Za-z]{22}$
            type: string
        - description: Filter by platform (searchable platforms only)
          in: query
          name: platform
          required: false
          schema:
            enum:
              - facebook
              - instagram
              - telegram
              - whatsapp
              - sms
              - rcs
              - slack
              - imessage
            type: string
        - description: One of your social accounts (acc_...).
          in: query
          name: accountId
          required: false
          schema:
            pattern: ^acc_[0-9A-Za-z]{22}$
            type: string
        - description: Maximum number of conversations to return
          in: query
          name: limit
          required: false
          schema:
            default: 20
            maximum: 50
            minimum: 1
            type: integer
        - description: >-
            Opaque pagination cursor. Pass back pagination.nextCursor verbatim;
            do not construct one.
          in: query
          name: cursor
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      properties:
                        conversation:
                          properties:
                            accountId:
                              description: One of your social accounts (acc_...).
                              pattern: ^acc_[0-9A-Za-z]{22}$
                              type: string
                            businessScopedUserId:
                              description: >-
                                WhatsApp only. Meta business-scoped user ID
                                (BSUID), the stable identity anchor; present
                                when Meta has sent it for this participant.
                              type: string
                            id:
                              description: >-
                                Conversation ID, usable with the conversation
                                messages endpoints
                              type: string
                            lastMessage:
                              description: The conversation's most recent message preview
                              type:
                                - string
                                - 'null'
                            lastMessageAt:
                              format: date-time
                              type:
                                - string
                                - 'null'
                            participantName:
                              type:
                                - string
                                - 'null'
                            participantPicture:
                              type:
                                - string
                                - 'null'
                            participantUsername:
                              type:
                                - string
                                - 'null'
                            platform:
                              type: string
                            status:
                              enum:
                                - active
                                - archived
                              type: string
                            whatsappUsername:
                              description: >-
                                WhatsApp only. The participant's WhatsApp
                                username (e.g. `jane.shop`, no leading @). Not a
                                stable identifier, because users can change it:
                                useful for display, not recommended as an
                                identity anchor. Captured from inbound messages,
                                so older threads fill in on their next inbound.
                              type: string
                          type: object
                        matchCount:
                          description: >-
                            Number of matching messages in this conversation. 0
                            when the conversation matched only on contact
                            identity (name, username, or phone number), not on
                            message text.
                          type: integer
                        matches:
                          description: >-
                            Up to 3 most-recent matching messages (empty for an
                            identity-only match)
                          items:
                            properties:
                              direction:
                                enum:
                                  - incoming
                                  - outgoing
                                type: string
                              id:
                                type: string
                              text:
                                type:
                                  - string
                                  - 'null'
                              timestamp:
                                format: date-time
                                type: string
                            type: object
                          type: array
                      type: object
                    type: array
                  meta:
                    properties:
                      accountsFailed:
                        type: integer
                      accountsQueried:
                        type: integer
                      accountsSkipped:
                        description: >-
                          Connected messaging accounts that cannot be searched
                          (live-fetched platforms)
                        items:
                          properties:
                            accountId:
                              description: One of your social accounts (acc_...).
                              pattern: ^acc_[0-9A-Za-z]{22}$
                              type: string
                            platform:
                              type: string
                          type: object
                        type: array
                      failedAccounts:
                        items:
                          properties:
                            accountId:
                              description: One of your social accounts (acc_...).
                              pattern: ^acc_[0-9A-Za-z]{22}$
                              type: string
                            accountUsername:
                              type:
                                - string
                                - 'null'
                            error:
                              type: string
                            platform:
                              type: string
                          type: object
                        type: array
                      lastUpdated:
                        format: date-time
                        type: string
                    type: object
                  pagination:
                    properties:
                      hasMore:
                        type: boolean
                      nextCursor:
                        type:
                          - string
                          - 'null'
                    type: object
                type: object
          description: Conversations containing the query, most recent match first
        default:
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type:
                          - string
                          - 'null'
                      details:
                        additionalProperties: {}
                        type:
                          - object
                          - 'null'
                      message:
                        type:
                          - string
                          - 'null'
                      param:
                        type:
                          - string
                          - 'null'
                      retryHint:
                        enum:
                          - never
                          - after_delay
                          - after_reconnect
                          - reconcile_first
                          - null
                        type:
                          - string
                          - 'null'
                      retryable:
                        type:
                          - boolean
                          - 'null'
                      type:
                        type:
                          - string
                          - 'null'
                    type:
                      - object
                      - 'null'
                type: object
          description: Error. The code field is stable; see the error catalog.
components:
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.