INinstantly
SuperSearchEnrichment

Get AI enrichment for resource

Changed on

Get the AI enrichment for a specific resource

Requires one of the following scopes: supersearch_enrichments:read, supersearch_enrichments:all, all:read, all:all

get/api/v2/supersearch-enrichment/ai/{resource_id}/in-progress

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/supersearch-enrichment/ai/{resource_id}/in-progress
  • Auth
    HTTP bearer

Path parameters

resource_idstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

The ID of the list or campaign to retrieve the AI enrichment.

Query parameters

offsetinteger

Number of AI jobs and of integration jobs to skip

limitinteger
Example:10

Maximum number of AI jobs and of integration jobs to return

Response

Default Response

idstring

Unique identifier for the enrichment

organization_idstring uuid required

Organization ID that owns this enrichment

resource_idstring uuid required

ID of the resource being enriched

resource_type1 | 2 required

Type of the resource (1 for Campaign, 2 for List)

output_columnstring required

Name of the column where results will be stored

statusnumber required

Status of the enrichment job

Example response

[
  {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "organization_id": "01234567-89ab-cdef-0123-456789abcdef",
    "resource_id": "01234567-89ab-cdef-0123-456789abcdef",
    "resource_type": 1,
    "output_column": "ai_generated_content",
    "status": 1
  }
]

Changes

  • c781051105a8Revision changes
    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      removed the CAMPAIGN enum value from the / response property for the response status

    • info

      removed the LIST enum value from the / response property for the response status