> ## 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.

# Ingest a Creator On Demand

> Request ingestion of a creator we do not yet have. The handle is validated live before anything is created, then a profile is seeded and enrichment begins asynchronously.

**How it works:**
1. The handle is normalized and validated live to confirm it exists
2. If we already have the creator, you get `200` with `status: already_exists` and are not charged
3. Otherwise a profile is seeded and you get `202` with `status: ingesting`

**Polling for results:**
Use the returned `status_url` (`GET /v1/creators/{id}`) to poll for the built profile. Basic header details are usually available within about a minute; full analysis and synthesized fields fill in within about a day. While the profile is still building, that endpoint may return `404` or sparse fields.

**Limits:**
- Only `instagram` is supported today
- Each account has a daily ingest quota; exceeding it returns `429` with `quota_exceeded` and a `Retry-After` header
- Handles that do not exist return `404` and are not charged

**Pricing**: 5 credits per creator ingested ($0.05). Charged only when a new creator is seeded — existing, not-found, and invalid handles are free.



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/influship-api/openapi.documented.yml post /v1/creators/ingest
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


    ## Agentic Payments


    The security entries in this base SDK contract describe `X-API-Key`
    authentication. The hosted discovery document at
    `https://api.influship.com/openapi.json` augments currently enabled paid
    operations with `402` responses and `x-payment-info` metadata for x402 v2
    and MPP. Use that hosted document when building no-key payment clients
    because supported operations and payment rails are deployment-dependent.


    ## 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/ingest:
    post:
      tags:
        - Creators
      summary: Ingest a Creator On Demand
      description: >-
        Request ingestion of a creator we do not yet have. The handle is
        validated live before anything is created, then a profile is seeded and
        enrichment begins asynchronously.


        **How it works:**

        1. The handle is normalized and validated live to confirm it exists

        2. If we already have the creator, you get `200` with `status:
        already_exists` and are not charged

        3. Otherwise a profile is seeded and you get `202` with `status:
        ingesting`


        **Polling for results:**

        Use the returned `status_url` (`GET /v1/creators/{id}`) to poll for the
        built profile. Basic header details are usually available within about a
        minute; full analysis and synthesized fields fill in within about a day.
        While the profile is still building, that endpoint may return `404` or
        sparse fields.


        **Limits:**

        - Only `instagram` is supported today

        - Each account has a daily ingest quota; exceeding it returns `429` with
        `quota_exceeded` and a `Retry-After` header

        - Handles that do not exist return `404` and are not charged


        **Pricing**: 5 credits per creator ingested ($0.05). Charged only when a
        new creator is seeded — existing, not-found, and invalid handles are
        free.
      operationId: ingestCreator
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IngestCreatorRequest'
        description: On-demand creator ingest request
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IngestCreatorResponse'
        '202':
          description: 202 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IngestCreatorResponse'
        '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'
        '402':
          description: >-
            Payment required response. Returned when the account balance or plan
            cannot cover the request cost.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error402'
        '404':
          description: Not found error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '422':
          description: >-
            Unprocessable entity response. The request was well-formed but a
            value failed a semantic rule (e.g. an invalid social handle format).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
        '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'
        '503':
          description: >-
            Service unavailable response for temporary upstream dependency
            failures, including payment facilitators and live-data provider
            throttling. Check Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error503'
components:
  schemas:
    IngestCreatorRequest:
      type: object
      properties:
        platform:
          $ref: '#/components/schemas/Platform'
          description: >-
            Platform of the handle to ingest. Only `instagram` is supported
            today.
        username:
          type: string
          minLength: 1
          maxLength: 50
          description: >-
            Handle to ingest. A leading `@` is stripped and the handle is
            lowercased before validation.
          example: fitness_coach_jane
        source_query:
          description: >-
            Optional free-text note describing why this creator is being
            ingested (e.g. the search that surfaced them). Stored for your own
            attribution; does not affect processing.
          example: vegan fitness coaches in Austin
          type: string
          maxLength: 500
      required:
        - platform
        - username
      description: On-demand creator ingest request
    IngestCreatorResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/IngestCreatorResponseData'
      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
    Error402:
      $ref: '#/components/schemas/Error'
      description: >-
        Payment required response. Returned when the account balance or plan
        cannot cover the request cost.
      examples:
        - error:
            code: payment_required
            message: Insufficient credit balance for this request
            request_id: 550e8400-e29b-41d4-a716-446655440000
    Error404:
      $ref: '#/components/schemas/Error'
      description: Not found error response
      examples:
        - error:
            code: not_found
            message: Creator with ID '123e4567-e89b-12d3-a456-426614174000' not found
            request_id: 550e8400-e29b-41d4-a716-446655440000
    Error422:
      $ref: '#/components/schemas/Error'
      description: >-
        Unprocessable entity response. The request was well-formed but a value
        failed a semantic rule (e.g. an invalid social handle format).
      examples:
        - error:
            code: validation_error
            message: Invalid Instagram username format
            param: username
            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
    Error503:
      $ref: '#/components/schemas/Error'
      description: >-
        Service unavailable response for temporary upstream dependency failures,
        including payment facilitators and live-data provider throttling. Check
        Retry-After when present.
      examples:
        - error:
            code: service_unavailable
            message: >-
              Live Instagram data is temporarily unavailable. Please retry
              shortly.
            request_id: 550e8400-e29b-41d4-a716-446655440000
            details:
              retry_after_seconds: 60
              upstream_error: upstream_rate_limited
    Platform:
      type: string
      enum:
        - instagram
      description: Social media platform
      example: instagram
    IngestCreatorResponseData:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/IngestStatus'
        creator:
          $ref: '#/components/schemas/IngestCreatorRef'
        status_url:
          type: string
          description: >-
            Relative URL of the pollable creator resource. Returns the creator
            once enrichment has produced data; may return 404 or sparse data
            while the profile is still building.
          example: /v1/creators/123e4567-e89b-12d3-a456-426614174000
      required:
        - status
        - creator
        - status_url
      additionalProperties: false
      description: On-demand creator ingest result
    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
    IngestStatus:
      type: string
      enum:
        - ingesting
        - already_exists
      description: Ingest outcome
      example: ingesting
    IngestCreatorRef:
      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 unique identifier. Poll `status_url` to retrieve the full
            profile.
          example: 123e4567-e89b-12d3-a456-426614174000
        username:
          type: string
          description: Normalized handle
          example: fitness_coach_jane
        platform:
          $ref: '#/components/schemas/Platform'
      required:
        - id
        - username
        - platform
      additionalProperties: false
    ErrorCode:
      type: string
      enum:
        - validation_error
        - invalid_parameter
        - missing_parameter
        - unauthorized
        - forbidden
        - payment_required
        - not_found
        - rate_limit_exceeded
        - quota_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

````