Types
On this page, we'll dive into the different types you can use to interact with the UL API.
The Company type
A Company is a type that contains information about a company that R1 needs to research.
Required Properties
- Name
website- Type
- string
- Description
The website of the company. Must be a valid URL.
Optional Properties
- Name
name- Type
- string
- Description
The name of the company.
- Name
description- Type
- string
- Description
The description of the company's business, products, services, and activities.
The Person type
A Person is a type that contains information about a person that R1 needs to research.
Required Properties
- Name
full_name- Type
- string
- Description
The full name of the person. Must have at least 1 character.
Optional Properties
- Name
linkedin_url- Type
- string
- Description
The LinkedIn URL of the person.
- Name
email- Type
- string
- Description
The email address of the person.
- Name
job_title- Type
- string
- Description
The job title of the person.
The Lead type
A Lead is a type that contains information about the company and optionally person you're researching.
Required Properties
- Name
company- Type
- Company
- Description
The company you're researching. See the Company type for more information.
Optional Properties
- Name
person- Type
- Person
- Description
The person you're researching. See the Person type for more information.
The User type
In case you're researching on behalf of another company or person, you can provide user information to R1. The user R1 is researching on behalf of is just as impactful to the outcome of the research as the company or person you're researching.
Required Properties
- Name
company- Type
- Company
- Description
The company of the user. See the Company type for more information.
Optional Properties
- Name
person- Type
- Person
- Description
The person of the user. See the Person type for more information.
The Event type
An Event is a type that contains relevant information about something that happened which R1 can use as context.
Required Properties
- Name
description- Type
- string
- Description
A free-form description of the event. Some examples: "[Lead] signed up for a free trial", "[Lead] just raised a $2.5M Series A funding round", "[Person] just joined [company] as [job title]", "[Person] just posted this on LinkedIn: [content]"
Optional Properties
- Name
timestamp_ms- Type
- number
- Description
The timestamp of when the event happened in milliseconds since the Unix epoch.
The ResearchStep type
A ResearchStep is a type that contains information about a step that R1 took during a research run.
Required Properties
- Name
action- Type
- string
- Description
A description of the action that R1 took.
Optional Properties
- Name
outcome- Type
- string
- Description
The outcome of the action.
The Research type
A Research is a type that contains information about the research an agent has performed.
Required Properties
- Name
steps- Type
- ResearchStep[]
- Description
The steps that R1 took during the research run. Might contain intermediate results.
Optional Properties
- Name
conclusion- Type
- string
- Description
The conclusion of the research run. Only available if the research run is completed.
The ResearchResult type
A ResearchResult is a type that contains information about the result of a research run.
Required Properties
- Name
research- Type
- Research
- Description
The result of the research required for the research run. See the Research type for more information.
The Qualification type
A Qualification is a type that contains information about whether the agent thinks the lead is qualified to be contacted.
Required Properties
- Name
score- Type
- enum['low', 'medium', 'high']
- Description
The qualification score of the lead.
- Name
reason- Type
- string
- Description
The reason for the qualification score.
The Timing type
A Timing is a type that contains information about whether the agent thinks the timing is right for contacting a lead.
Required Properties
- Name
score- Type
- enum['low', 'medium', 'high']
- Description
The timing score of the lead.
- Name
reason- Type
- string
- Description
The reason for the timing score.
The QualificationResult type
A QualificationResult is a type that contains information about the result of a qualification run.
Required Properties
- Name
research- Type
- Research
- Description
The result of the research required for the qualification run. See the Research type for more information.
Optional Properties
- Name
qualification- Type
- Qualification
- Description
The qualification of the lead. See the Qualification type for more information.
The TimingResult type
A TimingResult is a type that contains information about the result of a timing run.
Required Properties
- Name
research- Type
- Research
- Description
The result of the research required for the timing run. See the Research type for more information.
Optional Properties
- Name
timing- Type
- Timing
- Description
The timing of the lead. See the Timing type for more information.
The Classification type
A Classification is a type that contains information about the classification of a lead.
Required Properties
- Name
choice- Type
- string
- Description
The choice of the classification. If the agent is not able to make a choice, the value will be
"unknown".
- Name
reason- Type
- string
- Description
The reason behind the classification choice.
The ClassificationResult type
A ClassificationResult is a type that contains information about the result of a classification run.
Required Properties
- Name
research- Type
- Research
- Description
The result of the research required for the classification run. See the Research type for more information.
Optional Properties
- Name
classification- Type
- Classification
- Description
The classification of the lead. See the Classification type for more information.
The LanguageCode type
The LanguageCode type represents the supported languages for message generation. It's a string literal type that accepts any of the following language codes:
| Code | Language | Region |
|---|---|---|
en-US | English | United States |
en-UK | English | United Kingdom |
en-AU | English | Australia |
nl | Dutch | Netherlands |
de | German | Germany |
lb | Luxembourgish | Luxembourg |
fr | French | France |
es | Spanish | Spain and Latin America |
pt | Portuguese | Portugal |
it | Italian | Italy |
gr | Greek | Greece |
ru | Russian | Russia |
tr | Turkish | Turkey |
da | Danish | Denmark |
sv | Swedish | Sweden |
fi | Finnish | Finland |
is | Icelandic | Iceland |
no | Norwegian | Norway |
zh | Chinese | China |
ja | Japanese | Japan |
hi | Hindi | India |
th | Thai | Thailand |
vi | Vietnamese | Vietnam |
my | Burmese | Myanmar |
ko | Korean | Korea |
et | Estonian | Estonia |
lt | Lithuanian | Lithuania |
lv | Latvian | Latvia |
mk | Macedonian | North Macedonia |
id | Indonesian | Indonesia |
cs | Czech | Czech Republic |
pl | Polish | Poland |
sl | Slovenian | Slovenia |
sk | Slovak | Slovakia |
bg | Bulgarian | Bulgaria |
bs | Bosnian | Bosnia |
hu | Hungarian | Hungary |
uk | Ukrainian | Ukraine |
sr | Serbian | Serbia |
ro | Romanian | Romania |
sq | Albanian | Albania |
hy | Armenian | Armenia |
he | Hebrew | Israel |
ar | Arabic | Various |
If you need support for a language that isn't listed here, please contact support.
The Message type
A Message is a type that contains information about a message that R1-C generated.
- Name
subject- Type
- string
- Description
The subject of the message.
- Name
body- Type
- { markdown: string, html: string }
- Description
The body of the message, in both markdown and HTML format.
The CopywritingResult type
A CopywritingResult is a type that contains information about the result of a copywriting run.
- Name
research- Type
- Research
- Description
The result of the research required for the copywriting run. See the Research type for more information.
Optional Properties
- Name
message- Type
- Message
- Description
The message generated by the copywriting run. See the Message type for more information. Only available if the copywriting run is completed.