Skip to main content
POST
Create a linkedin post agent

Authorizations

Authorization
string
header
required

Your API token (af_…) as the Basic-auth username, with an empty password.

Body

application/json
fieldsToScrape
enum<string>[]
required

Which engagement to collect: "likes" (reactors), "comments" (commenters), or both. At least one is required.

Minimum array length: 1
Available options:
likes,
comments
listName
string
required

Name for BOTH the agent and the results list it creates. Must be unique across your agents: a name already in use is rejected with 409 LIST_NAME_TAKEN.

start
boolean
default:false

true creates AND activates the agent (spends credits); false (default) saves a draft to activate later.

postUrl
string

One LinkedIn post URL (a /feed/update/, /posts/ or /pulse/ link). Provide exactly one of postUrl or postUrls.

postUrls
string[]

Up to 50 unique LinkedIn post URLs (/feed/update/, /posts/ or /pulse/ links). Provide exactly one of postUrl or postUrls.

Required array length: 1 - 50 elements
enableRecurring
boolean
default:false

Keep the scrape running on a recurring schedule instead of a single one-shot run.

enrichPhone
boolean
default:false

Also enrich every delivered contact with a phone number. Costs additional credits per contact enriched.

enrichEmail
boolean
default:false

Also enrich every delivered contact with a work email address. Costs additional credits per contact enriched.

maxCreditSpend
integer

Maximum credits this agent may spend in a single run or refresh (1000 to 200000); delivery-driven monitors stop once their total delivered results reach it. Omit for no limit.

Required range: 1000 <= x <= 200000

Response

Success

agent
object
required