Skip to content
WaalaxyWaalaxy AI API

Get an agent

GET
/v1/agents/{id}
curl --request GET \
  --url https://developers.waalaxy.ai/v1/agents/example \
  --header 'Authorization: Bearer <token>'

Get a prospecting agent

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 1 characters

GET /v1/agents/:id Parameter

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
status
required
string
Allowed value: success
data
required
object
id
required
string
workspaceId
required
string
linkedinAccountIds
required
Array<string>
name
required
string
memory
required
object
writingRules
required
Array<string>
companyFacts
required
Array<string>
offerFacts
required
Array<string>
companyTargetId
required
string
companyTarget
required
object
id
required
string
workspaceId
required
string
name
required
string
valueProposition
required
string
painPoint
required
string
fitScore
required
integer | null
<= 100
differentiators
required
Array<string>
icpJobTitles
required
Array<string>
icpIndustry
required
Array<string>
icpCompanySize
required
Array<string>
icpLocation
required
string
icpYearsOfExperience
required
Array<string>
icpYearsInCurrentPosition
required
Array<string>
icpCompanyType
required
Array<string>
icpGender
required
Array<string>
createdAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
updatedAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
conversionAction
required
object
conversionAction
required
string
Allowed values: BOOK_A_CALL LINK_ACTION DIRECT_CONTACT FREE_TRIAL WEBINAR_SIGNUP EVENT_SIGNUP LEAD_MAGNET CASE_STUDY SALES_DEMO FREE_AUDIT WAITLIST SEND_COLLATERAL SHARE_CONTACT GENERIC_LINK CUSTOM
payload
required
summary
string
>= 1 characters
autonomyLevel
required
string
Allowed values: ASSISTED SEMI_AUTONOMOUS AUTONOMOUS
recommendedAutonomyLevel
required
string
Allowed values: ASSISTED SEMI_AUTONOMOUS AUTONOMOUS
forceHandoffOnFirstDecision
required
boolean
disableLeadExit
required
boolean
linkTrackingEnabled
required
boolean
humanizerEnabled
required
boolean
status
required
string
Allowed values: ACTIVE PAUSED
pausedAt
required
string | null format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
createdAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
updatedAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
Example
{
  "status": "success",
  "data": {
    "conversionAction": {
      "conversionAction": "BOOK_A_CALL"
    },
    "autonomyLevel": "ASSISTED",
    "recommendedAutonomyLevel": "ASSISTED",
    "status": "ACTIVE"
  }
}

400

Section titled “400”

Error, see Errors and rate limits

Media typeapplication/json
object
status
required
string
Allowed value: error
error
required
object
message
required
string
code
string
requestId
string
Example
{
  "status": "error"
}