AI Lists

Get AI list job status and results

Changed on

Get the status and results of an AI list generation job. Poll this endpoint until the job status is 'completed' or 'failed'.

get/v1/context/list/jobs/{job_id}

Request

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

Path parameters

job_idstring required

Job ID returned from create job endpoint

Query parameters

include_attributesboolean

Include full attributes for each record in the results

Response

Job status and results (if completed)

Example response

{
  "message": {
    "job_id": "12345678901234567",
    "status": "completed",
    "created_at": "2024-01-15T10:30:00Z",
    "count": 2,
    "query_interpretation": "Finding all venture capital firms in the workspace",
    "entities": [
      {
        "id": "32710180831586564",
        "name": "Sequoia Capital",
        "type": "company",
        "reason": "Sequoia Capital is a well-known venture capital firm",
        "highlights": [
          "Invested in multiple portfolio companies",
          "Active in Series A and B funding rounds"
        ],
        "attributes": {
          "domains": [
            "sequoiacap.com"
          ],
          "industries": [
            "Venture Capital"
          ]
        }
      },
      {
        "id": "32710180831586565",
        "name": "Andreessen Horowitz",
        "type": "company",
        "reason": "a16z is a prominent venture capital firm",
        "highlights": [
          "Focus on technology investments"
        ]
      }
    ]
  }
}

Changes

    • info

      api operation id getAIListJob was added

    • 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

    • 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

    • 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 optional property to the response with the status