NEnex
AI Lists

Create an AI List

Changed on

Create an AI-powered list generation job. The AI will search your workspace and generate a list of records matching your natural language query. Use the returned job_id to poll for results.

post/v1/context/list/jobs

Request

  • Base URL
    https://app.nex.ai/api/developers
  • Auth
    API key in header Authorization

Request body

querystring required

Natural language query to search items (e.g., 'all companies', 'high priority contacts')

object_typestring

Type of object to search - 'contact' or 'company' (default: 'contact')

limitinteger

Number of results (default: 50, max: 100)

include_attributesboolean

If true, includes all entity attribute values in response (default: false)

Example request

{
  "query": "all companies who have asked for a contract",
  "object_type": "company",
  "limit": 20,
  "include_attributes": true
}

Response

Job created successfully

Example response

{
  "message": {
    "job_id": "12345678901234567",
    "status": "pending"
  }
}

Changes

  • b05d8cb8cf43Revision changes
    • info

      api operation id createAIListJob was added

  • abb2dae0d348Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property default value changed from 20 to 50

    • info

      added the optional property to the response with the status