{"info":{"_postman_id":"cb26ee0e-3ab2-4717-b13f-e76699a8d5c0","name":"REST API","description":"

API Response Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP Code	Definition
200	Successful Request
401	Auth Failed (missing auth header or incorrect key)
402	Rate Limit Or Insufficient Funds (error case in body)
500	Unhandled error; we have been notified.

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"479833","collectionId":"cb26ee0e-3ab2-4717-b13f-e76699a8d5c0","publishedId":"2s93m62NHf","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-05-25T11:02:36.000Z"},"item":[{"name":"/api/test-key","id":"dcd2a2e4-2b5d-4d1b-94f4-d14f62635656","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"YOUR_TOKEN_HERE","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.trykitt.ai/api/test-key","description":"

Use this endpoint to test auth with your API key.

HTTP Code 200 means you passed auth
\n
HTTP Code 401 means there is a problem with the header or key
\n

\n","urlObject":{"protocol":"https","path":["api","test-key"],"host":["api","trykitt","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"dcd2a2e4-2b5d-4d1b-94f4-d14f62635656"},{"name":"/job?id=","id":"f901c94e-b35c-4cbf-81ad-2be934b791d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"YOUR_TOKEN_HERE"}],"url":"https://api.trykitt.ai/job?id=XXX","description":"

There are three ways to get data back from the Kitt API

Real-Time: preferred for all workloads, you'll get the job results in the API response. However, this API is throttled so if you submit more than your allotted concurrent request limit, you will get an error and will have to retry. However, you can request additional concurrency by contacting our support team.
\n
Webhook (deprecated): you can submit up to 100,000 jobs at once, and our back-end will process your requests in the background at the speed that your concurrency rate allows.
\n

\n","urlObject":{"protocol":"https","path":["job"],"host":["api","trykitt","ai"],"query":[{"key":"id","value":"XXX"}],"variable":[]}},"response":[],"_postman_id":"f901c94e-b35c-4cbf-81ad-2be934b791d8"},{"name":"/job/find_email","id":"1d3cbcb2-3805-474e-96ed-6cf935a79352","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"YOUR_TOKEN_HERE"}],"body":{"mode":"raw","raw":"{\n \"fullName\": \"erol Toker\", \n \"domain\": \"trykitt.ai\", \n \"linkedinStandardProfileURL\": \"https://linkedin.com/in/someprofile\",\n \"realtime\" : true,\n \"customData\": \"myInternalId\", \n \"callbackURL\" : \"only_used_if_realtime_param_is_false\",\n \"strictNameMatches\" : false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.trykitt.ai/job/find_email","description":"

Definitions:

fullName: the full name as it's listed on Linkedin or another directory. We recommend NOT doing any cleanup, as we handle all of it (foreign names, nicknames, maiden names, degrees/certifications, emojis, etc)
\n
domain: either the known email domain of the company or the company's website. If you pass in a website (eg: \"https://trykitt.ai\") we will extract the domain automagically.
\n
linkedinStandardProfileURL: the profile url of the person on linkedin
\n
callbackURL: where you want us to send the request results
\n

Required fields:

fullName
\n
website
\n

For the best results:

Email domains are better than websites. Websites are better than company names.
\n
Provide the linkedinStandardProfileURL (helps when the person has hidden their full name).
\n

\n","urlObject":{"protocol":"https","path":["job","find_email"],"host":["api","trykitt","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"1d3cbcb2-3805-474e-96ed-6cf935a79352"},{"name":"/job/verify_email","id":"549b1569-0ba6-4fdd-bb25-582d0b48ec2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"YOUR_TOKEN_HERE","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"erol@trykitt.ai\"\n , \"customData\": \"myInternalId\"\n , \"callbackURL\" : \"only_used_if_realtime_param_is_false\"\n , \"realtime\" : true\n , \"treatAliasesAsValid\" : true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.trykitt.ai/job/verify_email","urlObject":{"protocol":"https","path":["job","verify_email"],"host":["api","trykitt","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"549b1569-0ba6-4fdd-bb25-582d0b48ec2c"}]}