Skip to main content
POST
People Intelligence

Authorizations

x-api-key
string
header
required

Your Sixtyfour API key.

Headers

Idempotency-Key
string | null

Remembers a start so retries return the same Job without another charge. Maximum: 255 characters. A key is unique to one action within your organization. The same key with a different body returns 409 idempotency_key_reused. Uploads must match the filename and contents. JSON keys are remembered as long as the Job is available; CSV keys for 24 hours. Without a key, retries start new work.

Required string length: 1 - 255

Body

application/json
tier
enum<string>
required

Research depth: micro, low, medium, high or xhigh.

Available options:
micro,
low,
medium,
high,
xhigh
fields
Fields · object
required

Fields to research. Map each name to a prompt or a typed field definition.

input_file_id
string | null

Uploaded CSV, JSON or NDJSON file to process instead of inline records.

Maximum string length: 200
research_plan
string | null

Additional instructions to guide the research. Omit to use the default research approach.

Maximum string length: 100000
wait_seconds
integer
default:5

Seconds to wait for the Job to finish. Default: 5. Range: 0 to 20.

Required range: 0 <= x <= 20
webhook_url
string<uri> | null

HTTPS URL to notify when the Job finishes. Omit to use polling.

Required string length: 1 - 2048
person
Person · object | null

One person to research. Use instead of people or input_file_id.

people
People · object[] | null

People to research, up to 100,000 records. Use instead of person or input_file_id.

Required array length: 1 - 100000 elements

Response

Job finished within the wait window.

job_id
string
required

Job identifier, normally prefixed with job_. Store it exactly as returned. GET /v1/jobs/{job_id} also accepts IDs returned by unversioned endpoints.

status
enum<string>
required

Current Job status. Stop polling on succeeded, failed or canceled.

Available options:
queued,
running,
succeeded,
failed,
canceled
created_at
string<date-time>
required

UTC timestamp when the job was created, in ISO 8601 format.

operation
enum<string>
required

Action performed by the Job.

Available options:
people.search,
companies.search,
people.contacts,
people.contacts.reverse,
people.intelligence,
companies.intelligence,
lists.create,
exports.create,
workflows.run,
qa-agent.run,
verify-age.run
next_poll_after
integer | null

Seconds before the next poll. Present only while the Job is queued or running.

progress
Progress · object | null

Operation-specific progress while queued or running; omitted when unavailable.

result
any

Successful output when available; bulk jobs may return download links.

error
JobError · object | null

Failure details when available; omitted otherwise.

counts
JobCounts · object | null

Input record counts, when available.

charge_credits
number | null

Net credits captured at retrieval, including refunds. May change after the Job finishes; null when unavailable, unknown, or withheld by spend permissions.