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

# Autocomplete Search

> Fast typeahead search for creators by name or username. Optimized for search-as-you-type UIs with sub-100ms response times.

**Matching behavior:**
- Matches against creator name, username, and display name
- Results include which field matched and the matching value
- Prefix matching (e.g., "fit" matches "fitness_coach")

**Scope options:**
- `creator_only`: Return only the creator entity
- `matched_platforms`: Return only profiles that matched the query
- `all_platforms`: Return all linked profiles (default)

Also callable as the `autocomplete_creators` MCP tool — see [the MCP server guide](/guides/mcp-server) for setup.

**Pricing**: 0.05 credits per request ($0.0005)



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/influship-api/openapi.documented.yml get /v1/creators/autocomplete
openapi: 3.1.0
info:
  title: Influship API
  version: 1.0.0
  description: >
    Public API for creator search, profile lookup, and campaign-fit analysis.


    ## Authentication


    Send your API key in the `X-API-Key` header on every authenticated request.


    ```bash

    curl -H "X-API-Key: your_api_key"
    https://api.influship.com/v1/creators/autocomplete?q=fitness

    ```


    ## Billing and Rate Limits


    The API uses credit-based billing and credit-based rate limits.


    - every endpoint has a credit cost

    - successful responses include `X-Credits-Charged` and `X-Credits-Features`

    - rate limits are enforced with per-minute and per-hour credit budgets

    - rate limit state is returned in the `RateLimit-*` headers


    ## Pagination


    List endpoints use cursor pagination.


    - send `limit` to control page size

    - use `next_cursor` from the response to fetch the next page

    - stop when `has_more` is `false`


    Search has one special rule:


    - `POST /v1/search` creates a persisted search session

    - `GET /v1/search/{id}` paginates that session for free

    - free pagination is capped by the original search `limit`


    ## Errors


    Errors use a consistent shape:


    ```json

    {
      "error": {
        "code": "rate_limit_exceeded",
        "message": "Rate limit exceeded (per minute)"
      }
    }

    ```


    See each operation for exact request and response schemas.
  contact:
    name: Influship Support
    email: support@influship.com
  license:
    name: Proprietary
    url: https://influship.com/terms
servers:
  - url: https://api.influship.com
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Health
    description: API health and status endpoints
  - name: Creators
    description: >-
      Retrieve creator profiles and discover new creators through search,
      autocomplete, and lookalike matching. Creators are cross-platform entities
      that may have profiles on multiple social networks.
  - name: Profiles
    description: >-
      Access individual social media profiles with detailed metrics, growth
      data, and activity information. Profiles are platform-specific accounts
      linked to creators.
  - name: Creator Emails
    description: >-
      Look up known creator email addresses by creator ID or social username.
      Empty or unresolved results are not billable.
  - name: Posts
    description: >-
      Retrieve and analyze social media posts with engagement metrics, media
      content, and performance data.
  - name: Search
    description: >-
      AI-powered semantic search to find creators using natural language
      queries. Understands intent and context to match creators based on content
      themes, audience, and style.
  - name: Live Scraping
    description: >-
      Fetch fresh data directly from social platforms in real-time. Use when you
      need the most current information or data for profiles not yet in our
      database.
paths:
  /v1/creators/autocomplete:
    get:
      tags:
        - Creators
      summary: Autocomplete Search
      description: >-
        Fast typeahead search for creators by name or username. Optimized for
        search-as-you-type UIs with sub-100ms response times.


        **Matching behavior:**

        - Matches against creator name, username, and display name

        - Results include which field matched and the matching value

        - Prefix matching (e.g., "fit" matches "fitness_coach")


        **Scope options:**

        - `creator_only`: Return only the creator entity

        - `matched_platforms`: Return only profiles that matched the query

        - `all_platforms`: Return all linked profiles (default)


        Also callable as the `autocomplete_creators` MCP tool — see [the MCP
        server guide](/guides/mcp-server) for setup.


        **Pricing**: 0.05 credits per request ($0.0005)
      operationId: autocompleteCreators
      parameters:
        - schema:
            type: string
            minLength: 2
            maxLength: 100
            description: Search query (min 2 characters)
            example: fitness
          in: query
          name: q
          required: true
          description: Search query (min 2 characters)
        - schema:
            $ref: '#/components/schemas/Platform'
            description: Filter by platform
          in: query
          name: platform
          description: Filter by platform
        - schema:
            default: 5
            description: Maximum results to return
            example: 5
            type: integer
            minimum: 1
            maximum: 50
          in: query
          name: limit
          description: Maximum results to return
        - schema:
            default: all_platforms
            description: Which platforms to include in results
            example: all_platforms
            type: string
            enum:
              - creator_only
              - matched_platforms
              - all_platforms
          in: query
          name: scope
          description: Which platforms to include in results
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutocompleteResponse'
        '400':
          description: Validation error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: Authentication error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Permission error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '429':
          description: >-
            Rate limit exceeded response. Check Retry-After header for backoff
            timing. Also returned (without RateLimit-* headers) when an IP is
            temporarily blocked after repeated failed authentication attempts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: Internal server error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Influship from 'influship';


            const client = new Influship({
              apiKey: process.env['INFLUSHIP_API_KEY'], // This is the default and can be omitted
            });


            const response = await client.creators.autocomplete({ q: 'fitness'
            });


            console.log(response.data);
        - lang: Python
          source: |-
            import os
            from influship import Influship

            client = Influship(
                api_key=os.environ.get("INFLUSHIP_API_KEY"),  # This is the default and can be omitted
            )
            response = client.creators.autocomplete(
                q="fitness",
            )
            print(response.data)
components:
  schemas:
    Platform:
      type: string
      enum:
        - instagram
      description: Social media platform
      example: instagram
    AutocompleteResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AutocompleteResultItem'
          description: Autocomplete results
      required:
        - data
      additionalProperties: false
    Error400:
      $ref: '#/components/schemas/Error'
      description: Validation error response
      examples:
        - error:
            code: validation_error
            message: 'Invalid value for parameter ''limit'': must be between 1 and 100'
            param: limit
            request_id: 550e8400-e29b-41d4-a716-446655440000
    Error401:
      $ref: '#/components/schemas/Error'
      description: Authentication error response
      examples:
        - error:
            code: unauthorized
            message: API key missing or invalid
            request_id: 550e8400-e29b-41d4-a716-446655440000
    Error403:
      $ref: '#/components/schemas/Error'
      description: Permission error response
      examples:
        - error:
            code: forbidden
            message: Your plan does not include access to this endpoint
            request_id: 550e8400-e29b-41d4-a716-446655440000
    Error429:
      $ref: '#/components/schemas/Error'
      description: >-
        Rate limit exceeded response. Check Retry-After header for backoff
        timing. Also returned (without RateLimit-* headers) when an IP is
        temporarily blocked after repeated failed authentication attempts.
      examples:
        - error:
            code: rate_limit_exceeded
            message: Rate limit exceeded (per minute)
            request_id: 550e8400-e29b-41d4-a716-446655440000
        - error:
            code: rate_limit_exceeded
            message: Rate limit exceeded (per hour)
            request_id: 550e8400-e29b-41d4-a716-446655440001
        - error:
            code: rate_limit_exceeded
            message: Too many failed authentication attempts. Please try again later.
            request_id: 550e8400-e29b-41d4-a716-446655440002
    Error500:
      $ref: '#/components/schemas/Error'
      description: Internal server error response
      examples:
        - error:
            code: internal_error
            message: An unexpected error occurred. Please try again later.
            request_id: 550e8400-e29b-41d4-a716-446655440000
    AutocompleteResultItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
          description: Creator ID
          example: 123e4567-e89b-12d3-a456-426614174000
        name:
          type: string
          description: Creator name
          example: Jane Fitness
        avatar:
          type:
            - string
            - 'null'
          description: Avatar URL
          example: https://cdn.example.com/avatars/jane.jpg
        platforms:
          type: array
          items:
            $ref: '#/components/schemas/AutocompletePlatformMatch'
          description: Matching platforms
      required:
        - id
        - name
        - avatar
        - platforms
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              $ref: '#/components/schemas/ErrorCode'
              description: Machine-readable error code
            message:
              type: string
              description: Human-readable error message
              example: Request validation failed
            param:
              description: Parameter that caused the error (if applicable)
              example: query
              type: string
            request_id:
              description: Request ID for debugging
              example: 550e8400-e29b-41d4-a716-446655440000
              type: string
            details:
              description: Structured error context (e.g., field-level validation issues)
              type: object
              propertyNames:
                type: string
              additionalProperties: {}
          required:
            - code
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false
    AutocompletePlatformMatch:
      type: object
      properties:
        platform:
          $ref: '#/components/schemas/Platform'
        username:
          type: string
          example: fitness_coach_jane
        display_name:
          type:
            - string
            - 'null'
          example: Jane Fitness
        match_type:
          type: string
          enum:
            - name
            - username
            - display_name
          description: How the query matched this profile
          example: username
        match_field:
          type: string
          description: The field value that matched
          example: fitness_coach_jane
      required:
        - platform
        - username
        - display_name
        - match_type
        - match_field
      additionalProperties: false
    ErrorCode:
      type: string
      enum:
        - validation_error
        - invalid_parameter
        - missing_parameter
        - unauthorized
        - forbidden
        - payment_required
        - not_found
        - rate_limit_exceeded
        - internal_error
        - service_unavailable
        - database_error
        - seed_not_found
        - invalid_seeds
        - seed_resolution_failed
        - lookalike_failed
        - get_profiles_failed
        - post_analysis_failed
        - match_failed
        - scraping_failed
        - transcript_unavailable
      description: Machine-readable error code for programmatic handling
      example: validation_error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````