Skip to main content
GET
/
v1
/
research
/
{research_id}
Get Research
curl --request GET \
  --url https://api.happenstance.ai/v1/research/{research_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "status": "<string>",
  "query": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "profile": {
    "person_metadata": {
      "full_name": "<string>",
      "alternate_names": [
        "<string>"
      ],
      "profile_urls": [
        "<string>"
      ],
      "current_locations": [
        {
          "location": "<string>",
          "comments": "<string>",
          "urls": [
            "<string>"
          ]
        }
      ],
      "tagline": "<string>"
    },
    "employment": [
      {
        "company_name": "<string>",
        "job_title": "<string>",
        "start_date": "<string>",
        "end_date": "<string>",
        "description": "<string>",
        "urls": [
          "<string>"
        ]
      }
    ],
    "education": [
      {
        "university_name": "<string>",
        "degree": "<string>",
        "start_date": "<string>",
        "end_date": "<string>",
        "description": "<string>",
        "urls": [
          "<string>"
        ]
      }
    ],
    "projects": [
      {
        "title": "<string>",
        "description": "<string>",
        "start_date": "<string>",
        "end_date": "<string>",
        "urls": [
          "<string>"
        ]
      }
    ],
    "writings": [
      {
        "title": "<string>",
        "description": "<string>",
        "date": "<string>",
        "urls": [
          "<string>"
        ]
      }
    ],
    "hobbies": [
      {
        "description": "<string>",
        "urls": [
          "<string>"
        ]
      }
    ],
    "summary": {
      "text": "<string>",
      "urls": [
        "<string>"
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
research_id
string
required

Response

Successful Response

Response from GET /v1/research/{id} - retrieving research status and results.

​
id
string
required

Unique identifier for the research job

​
status
string
required

Status of the research job (RUNNING, COMPLETED, FAILED, FAILED_AMBIGUOUS)

​
query
string
required

Original research query

​
created_at
string
required

Timestamp when research was created (ISO 8601 format)

​
updated_at
string
required

Timestamp when research was last updated (ISO 8601 format)

​
profile
ProfileV1 · object

Research results (only populated when status is COMPLETED)