{"openapi":"3.1.0","info":{"title":"WebAutomation API (live)","description":"You can find all api endpoints of webautomation.io in below list. For all endpoints except homepage we have basic authentication. When you click 'Authorize' button you should enter your webautomation username (email) and password. Until you refresh this page you can continue using this credentials for POST requests and see response of our system.","version":"2.0.1"},"paths":{"/robots.txt":{"get":{"summary":"Get Robots Txt","operationId":"get_robots_txt_robots_txt_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/favicon.ico":{"get":{"summary":"Get Favicon","operationId":"get_favicon_favicon_ico_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/error":{"get":{"summary":"Create Error","operationId":"create_error_error_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/protected":{"get":{"summary":"Protected Route","operationId":"protected_route_protected_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"HTTPBasic":[]}]}},"/":{"get":{"summary":"Index","operationId":"index__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/test":{"get":{"summary":"Test","operationId":"test_test_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/scrape":{"post":{"summary":" Post","operationId":"_post_api_scrape_post","security":[{"HTTPBasic":[]}],"parameters":[{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Format"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body__post_api_scrape_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/fornova":{"get":{"summary":" Post","operationId":"_post_api_fornova_get","security":[{"HTTPBasic":[]}],"parameters":[{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Format"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body__post_api_fornova_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":" Post","operationId":"_post_api_fornova_post","security":[{"HTTPBasic":[]}],"parameters":[{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Format"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body__post_api_fornova_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/s":{"post":{"summary":" Post","operationId":"_post_s_post","security":[{"HTTPBasic":[]}],"parameters":[{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Format"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body__post_s_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sn":{"post":{"summary":" Post","operationId":"_post_sn_post","parameters":[{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Format"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body__post_sn_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/match_category":{"get":{"summary":"Get Match Category","description":"FastAPI route that calls the Django API for match_category.","operationId":"get_match_category_match_category_get","security":[{"HTTPBasic":[]}],"parameters":[{"name":"website","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"amazon","title":"Website"}},{"name":"phrase","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"","title":"Phrase"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sessions":{"get":{"summary":"Get Session List","description":"FastAPI route that calls for SessionList or Session with pk=session_id.","operationId":"get_session_list_sessions_get","security":[{"HTTPBasic":[]}],"parameters":[{"name":"pk","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pk"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sessions/{pk}":{"get":{"summary":"Get Session List","description":"FastAPI route that calls for SessionList or Session with pk=session_id.","operationId":"get_session_list_sessions__pk__get","security":[{"HTTPBasic":[]}],"parameters":[{"name":"pk","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pk"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sessions/data/{pk}":{"get":{"summary":"Get Session Data","description":"FastAPI route that calls SessionData for pk=session_id.","operationId":"get_session_data_sessions_data__pk__get","security":[{"HTTPBasic":[]}],"parameters":[{"name":"pk","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pk"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/extractors/domain/{domain}":{"get":{"summary":"Get Spiders","description":"FastAPI route that calls the Django API for SpiderList.\n\n- GET /spiders/{pk} for a specific spider by ID\n- GET /spiders/domain/{domain} for spiders by domain\n- GET /spiders for all spiders belonging to the user","operationId":"get_spiders_extractors_domain__domain__get","security":[{"HTTPBasic":[]}],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain"}},{"name":"pk","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pk"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/extractors/{pk}":{"get":{"summary":"Get Spiders","description":"FastAPI route that calls the Django API for SpiderList.\n\n- GET /spiders/{pk} for a specific spider by ID\n- GET /spiders/domain/{domain} for spiders by domain\n- GET /spiders for all spiders belonging to the user","operationId":"get_spiders_extractors__pk__get","security":[{"HTTPBasic":[]}],"parameters":[{"name":"pk","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pk"}},{"name":"domain","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/extractors":{"get":{"summary":"Get Spiders","description":"FastAPI route that calls the Django API for SpiderList.\n\n- GET /spiders/{pk} for a specific spider by ID\n- GET /spiders/domain/{domain} for spiders by domain\n- GET /spiders for all spiders belonging to the user","operationId":"get_spiders_extractors_get","security":[{"HTTPBasic":[]}],"parameters":[{"name":"pk","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pk"}},{"name":"domain","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/extractor/activate":{"post":{"summary":"Activate Extractor","description":"FastAPI route that calls the Django API for activating an extractor by spider_pd_id.\n\nExpected body:\n{\n    \"spider_pd_id\": <spider_pd_id>\n}\n\nReturns a response based on whether the spider is activated or not.","operationId":"activate_extractor_extractor_activate_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateExtractorRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBasic":[]}]}},"/extractor_domain/{pk}":{"get":{"summary":"Get Extractor Domains","description":"FastAPI route that retrieves the allowed domains for a specific extractor. pk=extractor_id","operationId":"get_extractor_domains_extractor_domain__pk__get","security":[{"HTTPBasic":[]}],"parameters":[{"name":"pk","in":"path","required":true,"schema":{"type":"integer","title":"Pk"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Add Extractor Domain","description":"FastAPI route that adds a new allowed domain to a specific extractor. pk=extractor_id\n\nBody should contain:\n{\n    \"domain\": \"example.com\"\n}","operationId":"add_extractor_domain_extractor_domain__pk__post","security":[{"HTTPBasic":[]}],"parameters":[{"name":"pk","in":"path","required":true,"schema":{"type":"integer","title":"Pk"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddExtractorDomainRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Remove Extractor Domain","description":"FastAPI route to remove an allowed domain from an extractor. pk=extractor_id\n\nQuery parameter should be:\ndomain=example.com","operationId":"remove_extractor_domain_extractor_domain__pk__delete","security":[{"HTTPBasic":[]}],"parameters":[{"name":"pk","in":"path","required":true,"schema":{"type":"integer","title":"Pk"}},{"name":"domain","in":"query","required":false,"schema":{"type":"string","default":"","title":"Domain"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/extractor_variables/{pk}":{"get":{"summary":"Get Extractor Variables","description":"Retrieve all variables and CLOSESPIDER_ITEMCOUNT for the given extractor ID (pk).","operationId":"get_extractor_variables_extractor_variables__pk__get","security":[{"HTTPBasic":[]}],"parameters":[{"name":"pk","in":"path","required":true,"schema":{"type":"integer","title":"Pk"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"summary":"Update Extractor Variables","description":"Update the extractor variables, for the given extractor ID (pk).\nBody should contain a list of dictionaries with keys 'key' and 'value'. You must get these key and value pairs from GET method of this endpoint.\nExample body:\n[{\"key\": \"max_page_limit\", \"value\": \"18\"}, {\"key\": \"CLOSESPIDER_ITEMCOUNT\", \"value\": \"14\"}]","operationId":"update_extractor_variables_extractor_variables__pk__put","security":[{"HTTPBasic":[]}],"parameters":[{"name":"pk","in":"path","required":true,"schema":{"type":"integer","title":"Pk"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExtractorVariableUpdateRequest"},"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/advance_settings/{pk}":{"get":{"summary":"Get Adjust Settings","description":"Retrieve the settings for the given extractor ID (pk).","operationId":"get_adjust_settings_advance_settings__pk__get","security":[{"HTTPBasic":[]}],"parameters":[{"name":"pk","in":"path","required":true,"schema":{"type":"integer","title":"Pk"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Post Adjust Settings","description":"Forward the settings adjustment request to extractor. See all possible settings_name and value pairs in GET method of this endpoint. pk=extractor_id","operationId":"post_adjust_settings_advance_settings__pk__post","security":[{"HTTPBasic":[]}],"parameters":[{"name":"pk","in":"path","required":true,"schema":{"type":"integer","title":"Pk"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdjustSettingsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/extractors/start_urls/{pk}":{"get":{"summary":"Get Spider Starter Link","description":"Get the starter links of a given extractor (spider). pk=extractor_id","operationId":"get_spider_starter_link_extractors_start_urls__pk__get","security":[{"HTTPBasic":[]}],"parameters":[{"name":"pk","in":"path","required":true,"schema":{"type":"integer","title":"Pk"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Post Spider Starter Link","description":"Add or update the starter links for a given extractor (spider). pk=extractor_id Make sure your starter links are valid. We are not validating your links during this process. You should send them as a list.","operationId":"post_spider_starter_link_extractors_start_urls__pk__post","security":[{"HTTPBasic":[]}],"parameters":[{"name":"pk","in":"path","required":true,"schema":{"type":"integer","title":"Pk"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{},"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete Spider Starter Link","description":"Delete all starter links for a given extractor (spider). pk=extractor_id","operationId":"delete_spider_starter_link_extractors_start_urls__pk__delete","security":[{"HTTPBasic":[]}],"parameters":[{"name":"pk","in":"path","required":true,"schema":{"type":"integer","title":"Pk"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/extractors/run/{pk}":{"get":{"summary":"Get Run Extractor","description":"Run the extractor now. pk=extractor_id","operationId":"get_run_extractor_extractors_run__pk__get","security":[{"HTTPBasic":[]}],"parameters":[{"name":"pk","in":"path","required":true,"schema":{"type":"integer","title":"Pk"}},{"name":"domain","in":"query","required":false,"schema":{"type":"string","title":"Domain"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/batch/":{"get":{"summary":"Get Batch List","description":"List of all user batches.","operationId":"get_batch_list_api_batch__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"HTTPBasic":[]}]},"post":{"summary":"Post Batch List","description":"Create a new batch and save the data to Solr.","operationId":"post_batch_list_api_batch__post","requestBody":{"content":{"application/json":{"schema":{"items":{"type":"object"},"type":"array","title":"Req Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBasic":[]}]}},"/api/batch/status/":{"get":{"summary":"Get Batch Status","description":"Get the status of a batch.","operationId":"get_batch_status_api_batch_status__get","security":[{"HTTPBasic":[]}],"parameters":[{"name":"batchid","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"batchid","title":"Batchid"},"description":"batchid"},{"name":"requestid","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"requestid","title":"Requestid"},"description":"requestid"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/batch/data":{"get":{"summary":"Get Batch Data","description":"List of all user batches by batchid or requestid.\nAccepts both query parameters and JSON body for backwards compatibility.","operationId":"get_batch_data_api_batch_data_get","security":[{"HTTPBasic":[]}],"parameters":[{"name":"batchid","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Batch ID for filtering","title":"Batchid"},"description":"Batch ID for filtering"},{"name":"requestid","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Request ID for filtering","title":"Requestid"},"description":"Request ID for filtering"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/batch/status/post":{"post":{"summary":"Post Batch Status","operationId":"post_batch_status_api_batch_status_post_post","requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Req Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBasic":[]}]}},"/api/batch/data/post":{"post":{"summary":"Post Batch Data","operationId":"post_batch_data_api_batch_data_post_post","requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Req Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBasic":[]}]}},"/sff":{"post":{"summary":"Sff Endpoint","operationId":"sff_endpoint_sff_post","requestBody":{"content":{"application/json":{"schema":{"items":{"type":"object"},"type":"array","title":"Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/account":{"get":{"tags":["v1"],"summary":"V1 Account","description":"Free endpoint: credit balance, plan, usage and rate limits for the\nkey making the call (spec 5.9).","operationId":"v1_account_v1_account_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Response"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/person/search":{"post":{"tags":["v1"],"summary":"V1 Person Search","description":"Segment search over the LinkedIn person dataset. 1 credit per profile\nreturned (pre-authorized at per_page, charged for actuals).","operationId":"v1_person_search_v1_person_search_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PersonSearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/person/count":{"post":{"tags":["v1"],"summary":"V1 Person Count","description":"Free segment count. Cached per filter set.","operationId":"v1_person_count_v1_person_count_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PersonCountRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/company/enrich":{"get":{"tags":["v1"],"summary":"V1 Company Enrich","description":"Company profile by LinkedIn URL, domain or name. 1 credit on match;\na miss is free.","operationId":"v1_company_enrich_v1_company_enrich_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"linkedin_url","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Linkedin Url"}},{"name":"domain","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/company/employees":{"get":{"tags":["v1"],"summary":"V1 Company Employees","description":"Paginated employees of a company, from the person dataset. 1 credit per\nprofile returned. Company identified by linkedin_url (direct join), or\nresolved from domain/name via the enrich ladder (free).","operationId":"v1_company_employees_v1_company_employees_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"linkedin_url","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Linkedin Url"}},{"name":"domain","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"title","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Page"}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","default":25,"title":"Per Page"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/person/enrich":{"get":{"tags":["v1"],"summary":"V1 Person Enrich","description":"Enrich one person by LinkedIn profile URL, from the database.\n1 credit on match; a miss is free.","operationId":"v1_person_enrich_v1_person_enrich_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/person/enrich/bulk":{"post":{"tags":["v1"],"summary":"V1 Person Enrich Bulk","description":"Enrich up to 100 people by LinkedIn URL in one call. 1 credit per match;\nmisses are free. Results preserve input order; each item reports found.","operationId":"v1_person_enrich_bulk_v1_person_enrich_bulk_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PersonEnrichBulkRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/datasets":{"get":{"tags":["v1"],"summary":"V1 Datasets List","description":"List the datasets available through the API. Free.","operationId":"v1_datasets_list_v1_datasets_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Response"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/datasets/{dataset_id}/schema":{"get":{"tags":["v1"],"summary":"V1 Dataset Schema","description":"Filterable fields and types for one dataset. Free.","operationId":"v1_dataset_schema_v1_datasets__dataset_id__schema_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/{dataset_id}/count":{"post":{"tags":["v1"],"summary":"V1 Dataset Count","description":"Count records matching filters. Free, cached per filter set.","operationId":"v1_dataset_count_v1_datasets__dataset_id__count_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1DatasetCountRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/{dataset_id}/search":{"post":{"tags":["v1"],"summary":"V1 Dataset Search","description":"Return records matching filters. Supports sort and field selection.\ndataset_search credits per record returned (pre-authorized at per_page,\ncharged for actuals).","operationId":"v1_dataset_search_v1_datasets__dataset_id__search_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1DatasetSearchRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/{dataset_id}/record":{"get":{"tags":["v1"],"summary":"V1 Dataset Record","description":"Look up the single best-matching record by key field(s) passed as query\nparams (e.g. ?url=... or ?domain=...). Generalizes company/enrich to any\ndataset. 1 dataset_search credit on a match; a miss is free (404).","operationId":"v1_dataset_record_v1_datasets__dataset_id__record_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/{dataset_id}/record/bulk":{"post":{"tags":["v1"],"summary":"V1 Dataset Record Bulk","description":"Bulk record lookup: match up to 100 values of one key field in a single\ncall (the generic, any-dataset form of /v1/person/enrich/bulk). 1\ndataset_search credit per match; misses are free. Results preserve input\norder; each item reports found.","operationId":"v1_dataset_record_bulk_v1_datasets__dataset_id__record_bulk_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1DatasetRecordBulkRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/{dataset_id}/facets":{"get":{"tags":["v1"],"summary":"V1 Dataset Facets","description":"Distinct values + counts for one or more fields (default 50, cap 500).\nFree. Powers filter UIs and value discovery.","operationId":"v1_dataset_facets_v1_datasets__dataset_id__facets_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}},{"name":"field","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"},"title":"Field"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/{dataset_id}/aggregate":{"post":{"tags":["v1"],"summary":"V1 Dataset Aggregate","description":"Group-by + metrics (count/avg/min/max/sum on numeric fields) over a\ndataset, with optional filters. Free. Omit group_by for overall stats.","operationId":"v1_dataset_aggregate_v1_datasets__dataset_id__aggregate_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1DatasetAggregateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ActivateExtractorRequest":{"properties":{"spider_pd_id":{"type":"integer","title":"Spider Pd Id"}},"type":"object","required":["spider_pd_id"],"title":"ActivateExtractorRequest"},"AddExtractorDomainRequest":{"properties":{"domain":{"type":"string","title":"Domain"}},"type":"object","required":["domain"],"title":"AddExtractorDomainRequest"},"AdjustSettingsRequest":{"properties":{"settings_name":{"type":"string","title":"Settings Name"},"settings_value":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Settings Value"}},"type":"object","required":["settings_name","settings_value"],"title":"AdjustSettingsRequest"},"Body__post_api_fornova_get":{"properties":{"url":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"},{"type":"null"}],"title":"Url"},"options":{"$ref":"#/components/schemas/ScrapeOptions"}},"type":"object","required":["options"],"title":"Body__post_api_fornova_get"},"Body__post_api_fornova_post":{"properties":{"url":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"},{"type":"null"}],"title":"Url"},"options":{"$ref":"#/components/schemas/ScrapeOptions"}},"type":"object","required":["options"],"title":"Body__post_api_fornova_post"},"Body__post_api_scrape_post":{"properties":{"url":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"},{"type":"null"}],"title":"Url"},"options":{"$ref":"#/components/schemas/ScrapeOptions"}},"type":"object","required":["options"],"title":"Body__post_api_scrape_post"},"Body__post_s_post":{"properties":{"url":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"},{"type":"null"}],"title":"Url"},"options":{"$ref":"#/components/schemas/ScrapeOptions"}},"type":"object","required":["options"],"title":"Body__post_s_post"},"Body__post_sn_post":{"properties":{"url":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"},{"type":"null"}],"title":"Url"},"options":{"$ref":"#/components/schemas/ScrapeOptions"}},"type":"object","required":["options"],"title":"Body__post_sn_post"},"ExtractorVariableUpdateRequest":{"properties":{"key":{"type":"string","title":"Key"},"value":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Value"}},"type":"object","required":["key","value"],"title":"ExtractorVariableUpdateRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ScrapeOptions":{"properties":{"domain":{"type":"string","title":"Domain"},"hotel_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Hotel Id"},"checkin_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Checkin Date"},"checkout_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Checkout Date"},"pos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pos"},"number_of_guests":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Number Of Guests"},"snapshot_required":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"null"}],"title":"Snapshot Required","default":false}},"additionalProperties":true,"type":"object","required":["domain"],"title":"ScrapeOptions"},"V1DatasetAggregateRequest":{"properties":{"group_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group By"},"metrics":{"items":{"type":"object"},"type":"array","title":"Metrics","default":[]},"filters":{"type":"object","title":"Filters","default":{}},"limit":{"type":"integer","title":"Limit","default":50}},"type":"object","title":"V1DatasetAggregateRequest"},"V1DatasetCountRequest":{"properties":{"filters":{"type":"object","title":"Filters","default":{}}},"type":"object","title":"V1DatasetCountRequest"},"V1DatasetRecordBulkRequest":{"properties":{"field":{"type":"string","title":"Field"},"values":{"items":{"type":"string"},"type":"array","title":"Values","default":[]}},"type":"object","required":["field"],"title":"V1DatasetRecordBulkRequest"},"V1DatasetSearchRequest":{"properties":{"filters":{"type":"object","title":"Filters","default":{}},"page":{"type":"integer","title":"Page","default":1},"per_page":{"type":"integer","title":"Per Page","default":25},"sort":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort"},"fields":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Fields"}},"type":"object","title":"V1DatasetSearchRequest"},"V1PersonCountRequest":{"properties":{"filters":{"type":"object","title":"Filters","default":{}}},"type":"object","title":"V1PersonCountRequest"},"V1PersonEnrichBulkRequest":{"properties":{"urls":{"items":{"type":"string"},"type":"array","title":"Urls","default":[]}},"type":"object","title":"V1PersonEnrichBulkRequest"},"V1PersonSearchRequest":{"properties":{"filters":{"type":"object","title":"Filters","default":{}},"page":{"type":"integer","title":"Page","default":1},"per_page":{"type":"integer","title":"Per Page","default":25},"sort":{"type":"string","title":"Sort","default":"recent"}},"type":"object","title":"V1PersonSearchRequest"},"V1Response":{"properties":{"status":{"type":"boolean","title":"Status"},"detail":{"items":{},"type":"array","title":"Detail"},"result":{"anyOf":[{},{"type":"null"}],"title":"Result"},"credits_used":{"type":"integer","title":"Credits Used","default":0},"credits_remaining":{"type":"integer","title":"Credits Remaining","default":0}},"type":"object","required":["status","detail"],"title":"V1Response"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"HTTPBasic":{"type":"http","scheme":"basic"},"HTTPBearer":{"type":"http","scheme":"bearer"}}}}