{"openapi":"3.1.0","info":{"title":"Circlemind - Zero","version":"0.1.0"},"paths":{"/api/v1/org/user":{"post":{"summary":"Create invite link","description":"Create an invite link for the given email and current organisation.","operationId":"create_invite_link_api_v1_org_user_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"email","in":"query","required":true,"schema":{"type":"string","title":"Email"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_dict_str__int__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/org":{"get":{"summary":"Get organisation","description":"Get the organisation for the current apikey.","operationId":"get_organisation_api_v1_org_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_OrganisationResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Update organisation","description":"Update the data of an organisation.","operationId":"update_organisation_api_v1_org_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"query","required":true,"schema":{"type":"string","title":"Name"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/usage":{"get":{"summary":"Get usage","description":"Get the current API credit balance, browser session balance, and plan name.","operationId":"get_usage_api_v1_usage_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_UsageResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/org/billing":{"get":{"summary":"Get billing URL","description":"Get the billing portal URL of the organisation.","operationId":"get_organisation_billing_portal_url_api_v1_org_billing_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_str_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/topup":{"post":{"summary":"Top up credits","description":"Top up credits for an organisation.","operationId":"topup_credits_api_v1_topup_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"amount","in":"query","required":true,"schema":{"type":"integer","title":"Amount"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_Union_bool__str__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/topup/auto":{"get":{"summary":"Get auto top up credits","description":"Get the auto top up credits for an organisation.","operationId":"get_auto_topup_credits_api_v1_topup_auto_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_IAutoTopUpCredits_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Auto top up credits","description":"Auto top up credits for an organisation.","operationId":"auto_topup_credits_api_v1_topup_auto_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"active","in":"query","required":true,"schema":{"type":"boolean","title":"Active"}},{"name":"amount","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Amount"}},{"name":"threshold","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Threshold"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_IAutoTopUpCredits_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/plan":{"post":{"summary":"Update plan","description":"Update the plan of an organisation.","operationId":"update_plan_api_v1_plan_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"plan","in":"query","required":true,"schema":{"type":"string","title":"Plan"}},{"name":"group","in":"query","required":false,"schema":{"type":"string","default":"zero","title":"Group"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_Union_IBillingPlan__str__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/task":{"post":{"summary":"Submit task","description":"Submit a task.","operationId":"run_task_api_v1_task_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_TaskResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"List tasks","description":"List all tasks for a user.","operationId":"list_tasks_api_v1_task_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"t","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"T"}},{"name":"l","in":"query","required":false,"schema":{"type":"integer","maximum":128,"minimum":1,"default":32,"title":"L"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_list_TaskResponse__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/task/{task_id}":{"delete":{"summary":"Stop task","description":"Stop a task by its ID.","operationId":"stop_task_api_v1_task__task_id__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"Get task","description":"Returns the status of a task by its ID.","operationId":"get_task_api_v1_task__task_id__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}},{"name":"event_t","in":"query","required":false,"schema":{"type":"integer","description":"Timestamp of last event received.","default":0,"title":"Event T"},"description":"Timestamp of last event received."},{"name":"downloads","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Downloads"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_TaskResponsePlusInternals_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"summary":"Update task","description":"Update a task by its ID.","operationId":"update_task_api_v1_task__task_id__put","deprecated":true,"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_bool_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/task/{task_id}/visibility":{"get":{"summary":"Get task visibility","description":"Get the visibility of a task by its ID.","operationId":"get_task_visibility_api_v1_task__task_id__visibility_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_bool_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Set task visibility","description":"Set the visibility of a task.","operationId":"set_task_visibility_api_v1_task__task_id__visibility_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}},{"name":"visibility","in":"query","required":true,"schema":{"type":"boolean","title":"Visibility"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_bool_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/task/{task_id}/data":{"delete":{"summary":"Delete task data","description":"Delete all data associated with the provided task","operationId":"delete_task_data_api_v1_task__task_id__data_delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_bool_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/task/{task_id}/event":{"post":{"summary":"Send task event","description":"Send an event to a running task.","operationId":"send_task_event_api_v1_task__task_id__event_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskEvent"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_TaskEventResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/profile":{"post":{"summary":"Create profile","description":"Creates a new browser profile.","operationId":"create_profile_api_v1_profile_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_ProfileResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"List profiles","description":"List all existing browser profiles.","operationId":"list_profiles_api_v1_profile_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_list_ProfileResponse__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/profile/{profile_id}":{"delete":{"summary":"Delete profile","description":"Delete a browser profile by id.","operationId":"delete_profile_api_v1_profile__profile_id__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","title":"Profile Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/proxy":{"get":{"summary":"List proxies","description":"List all proxies assigned to your organisation.","operationId":"list_proxies_api_v1_proxy_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_list_ProxyResponse__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/proxy/{proxy_id}":{"patch":{"summary":"Update proxy","description":"Turn a proxy's monthly renewal on or off. With renewal off, the proxy is released at its expiry date.","operationId":"update_proxy_api_v1_proxy__proxy_id__patch","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"proxy_id","in":"path","required":true,"schema":{"type":"string","title":"Proxy Id"}},{"name":"auto_renew","in":"query","required":true,"schema":{"type":"boolean","title":"Auto Renew"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_ProxyResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/extension":{"post":{"summary":"Upload an extension","description":"Upload a browser extension.","operationId":"upload_extension_api_v1_extension_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_extension_api_v1_extension_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_UploadExtensionResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"List extensions","description":"List all uploaded browser extensions.","operationId":"list_extensions_api_v1_extension_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_list_Extension__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/extension/{extension_id}":{"delete":{"summary":"Delete an extension","description":"Delete a specific browser extension.","operationId":"delete_extension_v2_api_v1_extension__extension_id__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"extension_id","in":"path","required":true,"schema":{"type":"string","title":"Extension Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_bool_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/browser/extension/{extension_id}":{"delete":{"summary":"Delete a browser extension","description":"Delete a specific browser extension for a user.","operationId":"delete_extension_api_v1_browser_extension__extension_id__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"extension_id","in":"path","required":true,"schema":{"type":"string","title":"Extension Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_bool_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/file":{"post":{"summary":"Upload a file","description":"Upload a file that will be used in a task.","operationId":"upload_file_api_v1_file_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_file_api_v1_file_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_UploadFileResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/file/{file_id}":{"delete":{"summary":"Delete an uploaded file","description":"Delete an uploaded file.","operationId":"delete_file_api_v1_file__file_id__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","title":"File Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_bool_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/browser/session":{"post":{"summary":"Open browser","description":"Open an interactive browser instance for 5 minutes.","operationId":"open_browser_session_api_v1_browser_session_post","deprecated":true,"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserSessionRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_BrowserSessionResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/browser/session/{session_id}":{"delete":{"summary":"Close browser session","description":"Close an interactive browser session by its ID","operationId":"close_browser_session_api_v1_browser_session__session_id__delete","deprecated":true,"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/browser/profile":{"get":{"summary":"List browser profiles","description":"List all created browser profiles for a user.","operationId":"list_browser_profiles_api_v1_browser_profile_get","deprecated":true,"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_BrowserProfilesResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/browser/profile/{profile_id}":{"delete":{"summary":"Delete a browser profile","description":"Delete a specific browser profile for a user.","operationId":"delete_browser_profile_api_v1_browser_profile__profile_id__delete","deprecated":true,"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","title":"Profile Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/browser/extension":{"post":{"summary":"Upload a browser extension","description":"Upload a browser extension.","operationId":"upload_browser_extension_api_v1_browser_extension_post","deprecated":true,"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_browser_extension_api_v1_browser_extension_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_UploadExtensionResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"List browser extensions","description":"List all uploaded browser extensions for a user.","operationId":"list_browser_extensions_api_v1_browser_extension_get","deprecated":true,"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_ListExtensionsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telemetry":{"post":{"summary":"Ingest telemetry events","description":"Receives batched SDK/CLI telemetry events and forwards them to PostHog.","operationId":"ingest_telemetry_api_v1_telemetry_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelemetryRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/job/{job_id}":{"get":{"summary":"Get task","description":"Get job by id.","operationId":"get_job_api_v1_job__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workspace":{"get":{"summary":"Get workspace","description":"Get workspace by id.","operationId":"get_workspace_api_v1_workspace_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workspace-id","in":"header","required":true,"schema":{"type":"string","title":"Workspace-Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workspace/{name}":{"post":{"summary":"Create workspace","description":"Create a new workspace for the current organisation.","operationId":"create_workspace_api_v1_workspace__name__post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}},{"name":"shared","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Shared"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/chat":{"get":{"summary":"List chats","description":"List all chats in the given workspace.","operationId":"get_chats_api_v1_chat_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"t","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"T"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":256,"title":"Limit"}},{"name":"workspace-id","in":"header","required":true,"schema":{"type":"string","title":"Workspace-Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatResponses"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/task/zero":{"post":{"summary":"Start a new task","description":"Execute the requested task.","operationId":"execute_task_api_v1_task_zero_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"t","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"T"}},{"name":"task_type","in":"query","required":false,"schema":{"$ref":"#/components/schemas/TASK_TYPE","default":"task"}},{"name":"workspace-id","in":"header","required":true,"schema":{"type":"string","title":"Workspace-Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ITask"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/chat/id":{"delete":{"summary":"Delete a chat","description":"Delete a chat.","operationId":"delete_chat_api_v1_chat_id_delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"t","in":"query","required":true,"schema":{"type":"integer","title":"T"}},{"name":"workspace-id","in":"header","required":true,"schema":{"type":"string","title":"Workspace-Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_bool_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"Get a chat","description":"Get a chat by its id.","operationId":"get_chat_api_v1_chat_id_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"t","in":"query","required":true,"schema":{"type":"integer","title":"T"}},{"name":"msg","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Msg"}},{"name":"workspace-id","in":"header","required":true,"schema":{"type":"string","title":"Workspace-Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Update a chat","description":"Update a chat title.","operationId":"update_chat_api_v1_chat_id_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"t","in":"query","required":true,"schema":{"type":"integer","title":"T"}},{"name":"title","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"}},{"name":"workspace-id","in":"header","required":true,"schema":{"type":"string","title":"Workspace-Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_bool_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/request/id":{"put":{"summary":"Update a request status","description":"Update the status of a request. For example, to approve or reject a tool call.","operationId":"update_request_api_v1_request_id_put","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string","title":"Id"}},{"name":"t","in":"query","required":true,"schema":{"type":"integer","title":"T"}},{"name":"status","in":"query","required":true,"schema":{"type":"string","title":"Status"}},{"name":"chat-id","in":"header","required":true,"schema":{"type":"string","title":"Chat-Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/chat/message":{"get":{"summary":"List messages","description":"List all messages for a given research.","operationId":"get_messages_api_v1_chat_message_get","parameters":[{"name":"t","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"T"}},{"name":"chat-id","in":"header","required":true,"schema":{"type":"string","title":"Chat-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Post message","description":"Post a new message to the given chat.","operationId":"create_message_api_v1_chat_message_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"t","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"T"}},{"name":"workspace-id","in":"header","required":true,"schema":{"type":"string","title":"Workspace-Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_create_message_api_v1_chat_message_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/attachment":{"get":{"summary":"Load an attachment","description":"Returns an attachment given its id.","operationId":"get_attachment_api_v1_attachment_get","parameters":[{"name":"attachment-id","in":"header","required":true,"schema":{"type":"string","title":"Attachment-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_AttachmentResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Update an attachment","description":"Update the content of the specified attachment.","operationId":"update_attachment_api_v1_attachment_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"t","in":"query","required":true,"schema":{"type":"integer","title":"T"}},{"name":"workspace-id","in":"header","required":true,"schema":{"type":"string","title":"Workspace-Id"}},{"name":"attachment-id","in":"header","required":true,"schema":{"type":"string","title":"Attachment-Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAttachmentRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_bool_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/app":{"get":{"summary":"List apps","description":"List all available apps for the organisation.","operationId":"list_apps_api_v1_app_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppConfigsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workspace/app/{app_name}":{"post":{"summary":"Connect app","description":"Add an app to the specified workspace.","operationId":"connect_app_api_v1_workspace_app__app_name__post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workspace-id","in":"header","required":true,"schema":{"type":"string","title":"Workspace-Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectAppRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskApiResponse_AppConnectionResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tool/{tool}/{id}":{"get":{"summary":"Get tool call data","description":"Return the data associated with a tool call.","operationId":"get_tool_call_data_api_v1_tool__tool___id__get","parameters":[{"name":"tool","in":"path","required":true,"schema":{"type":"string","title":"Tool"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sop":{"get":{"summary":"List sops","description":"List all sops in the given workspace.","operationId":"get_sops_api_v1_sop_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workspace-id","in":"header","required":true,"schema":{"type":"string","title":"Workspace-Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SOPResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Create/update sop","description":"Create or update a sop.","operationId":"set_sop_api_v1_sop_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"t","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"T"}},{"name":"workspace-id","in":"header","required":true,"schema":{"type":"string","title":"Workspace-Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SOPRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SOPResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete sop","description":"Delete a sop.","operationId":"delete_sop_api_v1_sop_delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"t","in":"query","required":true,"schema":{"type":"integer","title":"T"}},{"name":"workspace-id","in":"header","required":true,"schema":{"type":"string","title":"Workspace-Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/automation":{"get":{"summary":"List automations","description":"List all automations in the given workspace.","operationId":"get_automations_api_v1_automation_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workspace-id","in":"header","required":true,"schema":{"type":"string","title":"Workspace-Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_list_IAutomation__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Create automation","description":"Create an automation for a given workspace","operationId":"create_automation_api_v1_automation_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workspace-id","in":"header","required":true,"schema":{"type":"string","title":"Workspace-Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationCreationRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_IAutomation_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete automation","description":"Delete an automation.","operationId":"delete_automation_api_v1_automation_delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string","title":"Id"}},{"name":"workspace-id","in":"header","required":true,"schema":{"type":"string","title":"Workspace-Id"}},{"name":"apikey","in":"cookie","required":false,"schema":{"type":"string","title":"Apikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/webhook":{"post":{"summary":"Start automation","description":"Trigger an automation.","operationId":"webhook_handler_api_v1_webhook_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationWebhookRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"APP_PROTOCOL":{"type":"integer","enum":[-1,0,1,2],"title":"APP_PROTOCOL","description":"App protocol types."},"ApiResponse_AttachmentResponse_":{"properties":{"r":{"$ref":"#/components/schemas/AttachmentResponse"}},"type":"object","required":["r"],"title":"ApiResponse[AttachmentResponse]"},"ApiResponse_BrowserProfilesResponse_":{"properties":{"r":{"$ref":"#/components/schemas/BrowserProfilesResponse"}},"type":"object","required":["r"],"title":"ApiResponse[BrowserProfilesResponse]"},"ApiResponse_BrowserSessionResponse_":{"properties":{"r":{"$ref":"#/components/schemas/BrowserSessionResponse"}},"type":"object","required":["r"],"title":"ApiResponse[BrowserSessionResponse]"},"ApiResponse_IAutoTopUpCredits_":{"properties":{"r":{"$ref":"#/components/schemas/IAutoTopUpCredits"}},"type":"object","required":["r"],"title":"ApiResponse[IAutoTopUpCredits]"},"ApiResponse_IAutomation_":{"properties":{"r":{"$ref":"#/components/schemas/IAutomation"}},"type":"object","required":["r"],"title":"ApiResponse[IAutomation]"},"ApiResponse_ListExtensionsResponse_":{"properties":{"r":{"$ref":"#/components/schemas/ListExtensionsResponse"}},"type":"object","required":["r"],"title":"ApiResponse[ListExtensionsResponse]"},"ApiResponse_OrganisationResponse_":{"properties":{"r":{"$ref":"#/components/schemas/OrganisationResponse"}},"type":"object","required":["r"],"title":"ApiResponse[OrganisationResponse]"},"ApiResponse_ProfileResponse_":{"properties":{"r":{"$ref":"#/components/schemas/ProfileResponse"}},"type":"object","required":["r"],"title":"ApiResponse[ProfileResponse]"},"ApiResponse_ProxyResponse_":{"properties":{"r":{"$ref":"#/components/schemas/ProxyResponse"}},"type":"object","required":["r"],"title":"ApiResponse[ProxyResponse]"},"ApiResponse_TaskEventResponse_":{"properties":{"r":{"$ref":"#/components/schemas/TaskEventResponse"}},"type":"object","required":["r"],"title":"ApiResponse[TaskEventResponse]"},"ApiResponse_TaskResponsePlusInternals_":{"properties":{"r":{"$ref":"#/components/schemas/TaskResponsePlusInternals"}},"type":"object","required":["r"],"title":"ApiResponse[TaskResponsePlusInternals]"},"ApiResponse_TaskResponse_":{"properties":{"r":{"$ref":"#/components/schemas/TaskResponse"}},"type":"object","required":["r"],"title":"ApiResponse[TaskResponse]"},"ApiResponse_Union_IBillingPlan__str__":{"properties":{"r":{"anyOf":[{"$ref":"#/components/schemas/IBillingPlan"},{"type":"string"}],"title":"R"}},"type":"object","required":["r"],"title":"ApiResponse[Union[IBillingPlan, str]]"},"ApiResponse_Union_bool__str__":{"properties":{"r":{"anyOf":[{"type":"boolean"},{"type":"string"}],"title":"R"}},"type":"object","required":["r"],"title":"ApiResponse[Union[bool, str]]"},"ApiResponse_UploadExtensionResponse_":{"properties":{"r":{"$ref":"#/components/schemas/UploadExtensionResponse"}},"type":"object","required":["r"],"title":"ApiResponse[UploadExtensionResponse]"},"ApiResponse_UploadFileResponse_":{"properties":{"r":{"$ref":"#/components/schemas/UploadFileResponse"}},"type":"object","required":["r"],"title":"ApiResponse[UploadFileResponse]"},"ApiResponse_UsageResponse_":{"properties":{"r":{"$ref":"#/components/schemas/UsageResponse"}},"type":"object","required":["r"],"title":"ApiResponse[UsageResponse]"},"ApiResponse_bool_":{"properties":{"r":{"type":"boolean","title":"R"}},"type":"object","required":["r"],"title":"ApiResponse[bool]"},"ApiResponse_dict_str__int__":{"properties":{"r":{"additionalProperties":{"type":"integer"},"type":"object","title":"R"}},"type":"object","required":["r"],"title":"ApiResponse[dict[str, int]]"},"ApiResponse_list_Extension__":{"properties":{"r":{"items":{"$ref":"#/components/schemas/Extension"},"type":"array","title":"R"}},"type":"object","required":["r"],"title":"ApiResponse[list[Extension]]"},"ApiResponse_list_IAutomation__":{"properties":{"r":{"items":{"$ref":"#/components/schemas/IAutomation"},"type":"array","title":"R"}},"type":"object","required":["r"],"title":"ApiResponse[list[IAutomation]]"},"ApiResponse_list_ProfileResponse__":{"properties":{"r":{"items":{"$ref":"#/components/schemas/ProfileResponse"},"type":"array","title":"R"}},"type":"object","required":["r"],"title":"ApiResponse[list[ProfileResponse]]"},"ApiResponse_list_ProxyResponse__":{"properties":{"r":{"items":{"$ref":"#/components/schemas/ProxyResponse"},"type":"array","title":"R"}},"type":"object","required":["r"],"title":"ApiResponse[list[ProxyResponse]]"},"ApiResponse_list_TaskResponse__":{"properties":{"r":{"items":{"$ref":"#/components/schemas/TaskResponse"},"type":"array","title":"R"}},"type":"object","required":["r"],"title":"ApiResponse[list[TaskResponse]]"},"ApiResponse_str_":{"properties":{"r":{"type":"string","title":"R"}},"type":"object","required":["r"],"title":"ApiResponse[str]"},"AppConfigResponse":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"desc":{"type":"string","title":"Desc"},"icon":{"type":"string","title":"Icon"},"official":{"type":"boolean","title":"Official"},"protocol":{"$ref":"#/components/schemas/APP_PROTOCOL"},"unavailable":{"type":"string","title":"Unavailable"},"auths":{"items":{"type":"string"},"type":"array","title":"Auths"},"timestamp":{"type":"integer","title":"Timestamp"},"category":{"type":"string","title":"Category"}},"type":"object","required":["id","name","desc","icon","official","protocol","unavailable","auths","timestamp","category"],"title":"AppConfigResponse","description":"Sanitised app config response model."},"AppConfigsResponse":{"properties":{"r":{"additionalProperties":{"$ref":"#/components/schemas/AppConfigResponse"},"type":"object","title":"R"}},"type":"object","required":["r"],"title":"AppConfigsResponse","description":"App configs response model."},"AppConnectionResponse":{"properties":{"app":{"$ref":"#/components/schemas/IAppConnection"},"connection_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connection Url"},"discovery_task":{"anyOf":[{"$ref":"#/components/schemas/IAutomation"},{"type":"null"}]}},"type":"object","required":["app"],"title":"AppConnectionResponse","description":"Include redirect url to effectuate connection."},"AttachmentResponse":{"properties":{"title":{"type":"string","title":"Title"},"type":{"type":"string","title":"Type"},"content":{"type":"string","title":"Content"}},"type":"object","required":["title","type","content"],"title":"AttachmentResponse","description":"Attachment response model."},"AutomationCreationRequest":{"properties":{"title":{"type":"string","title":"Title"},"type":{"$ref":"#/components/schemas/TASK_TYPE"},"task":{"$ref":"#/components/schemas/ITask"},"trigger_type":{"$ref":"#/components/schemas/TRIGGER_TYPE"},"trigger_config":{"additionalProperties":true,"type":"object","title":"Trigger Config"}},"type":"object","required":["title","type","task","trigger_type","trigger_config"],"title":"AutomationCreationRequest","description":"Automations request model."},"AutomationWebhookRequest":{"properties":{"type":{"type":"string","title":"Type"},"timestamp":{"type":"string","title":"Timestamp"},"data":{"additionalProperties":true,"type":"object","title":"Data"}},"type":"object","required":["type","timestamp","data"],"title":"AutomationWebhookRequest","description":"Webhook request model."},"Body_create_message_api_v1_chat_message_post":{"properties":{"msg":{"type":"string","title":"Msg"},"attachments":{"items":{"type":"string","contentMediaType":"application/octet-stream"},"type":"array","title":"Attachments","default":[]}},"type":"object","required":["msg"],"title":"Body_create_message_api_v1_chat_message_post"},"Body_upload_browser_extension_api_v1_browser_extension_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"}},"type":"object","required":["file"],"title":"Body_upload_browser_extension_api_v1_browser_extension_post"},"Body_upload_extension_api_v1_extension_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"}},"type":"object","required":["file"],"title":"Body_upload_extension_api_v1_extension_post"},"Body_upload_file_api_v1_file_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"},"file_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Purpose"}},"type":"object","required":["file"],"title":"Body_upload_file_api_v1_file_post"},"BrowserProfilesResponse":{"properties":{"profile_ids":{"items":{"type":"string"},"type":"array","title":"Profile Ids","description":"The IDs of the browser profiles."},"session_ids":{"items":{"type":"string"},"type":"array","title":"Session Ids","description":"(Deprecated) Returns the session IDs.","readOnly":true}},"additionalProperties":true,"type":"object","required":["profile_ids","session_ids"],"title":"BrowserProfilesResponse","description":"Response model for listing browser profiles."},"BrowserSessionRequest":{"properties":{"profile_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Id","description":"The profile ID to use for the browser session. If None, a new profile will be created."},"live_view":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Live View","description":"Request a live URL to interact with the browser session.","default":true},"device":{"anyOf":[{"type":"string","enum":["desktop","mobile","desktop-lg"]},{"type":"null"}],"title":"Device","description":"The device type to use.","default":"desktop"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"The URL to open in the browser session."},"proxy_server":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy Server","description":"Proxy server address to route browser traffic through."},"proxy_username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy Username","description":"Proxy server username."},"proxy_password":{"anyOf":[{"type":"string","format":"password","writeOnly":true},{"type":"null"}],"title":"Proxy Password","description":"Proxy server password."},"proxy_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy Id","description":"Name of a Smooth-managed proxy to route browser traffic through, as returned by `list_proxies()`. Cannot be combined with `proxy_server`."},"extensions":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Extensions","description":"List of extensions to install for the task."},"use_stealth":{"type":"boolean","title":"Use Stealth","description":"Run the browser in stealth mode. Default is True.","default":true}},"additionalProperties":true,"type":"object","title":"BrowserSessionRequest","description":"Request model for creating a browser session."},"BrowserSessionResponse":{"properties":{"profile_id":{"type":"string","title":"Profile Id","description":"The ID of the browser profile associated with the opened browser instance."},"live_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Live Id","description":"The ID of the live browser session."},"live_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Live Url","description":"The live URL to interact with the browser session."},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Id","description":"(Deprecated) Returns the session ID.","readOnly":true}},"additionalProperties":true,"type":"object","required":["profile_id","session_id"],"title":"BrowserSessionResponse","description":"Browser session response model."},"Certificate":{"properties":{"file":{"anyOf":[{"type":"string","format":"password","writeOnly":true},{}],"title":"File","description":"p12 file object to be uploaded (e.g., open('cert.p12', 'rb'))."},"password":{"anyOf":[{"type":"string","format":"password","writeOnly":true},{"type":"null"}],"title":"Password","description":"Password to decrypt the certificate file. Optional."},"filters":{"anyOf":[{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},{"type":"null"}],"title":"Filters","description":"Reserved for future use to specify URL patterns where the certificate should be applied. Optional."}},"type":"object","required":["file"],"title":"Certificate","description":"Client certificate for accessing secure websites.\n\nAttributes:\n    file: p12 file object to be uploaded (e.g., open(\"cert.p12\", \"rb\")).\n    password: Password to decrypt the certificate file. Optional."},"ChatResponse":{"properties":{"r":{"prefixItems":[{"$ref":"#/components/schemas/IChat"},{"anyOf":[{"items":{"$ref":"#/components/schemas/IMessage"},"type":"array"},{"type":"null"}]}],"type":"array","maxItems":2,"minItems":2,"title":"R"}},"type":"object","required":["r"],"title":"ChatResponse","description":"Messages response model."},"ChatResponses":{"properties":{"r":{"items":{"$ref":"#/components/schemas/IChat"},"type":"array","title":"R"}},"type":"object","required":["r"],"title":"ChatResponses","description":"Research request model."},"ConnectAppRequest":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"type":{"type":"string","title":"Type"},"protocol":{"$ref":"#/components/schemas/APP_PROTOCOL"},"config":{"additionalProperties":true,"type":"object","title":"Config"}},"type":"object","required":["name","description","type","protocol","config"],"title":"ConnectAppRequest","description":"Connect app request model."},"Extension":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the extension."},"file_name":{"type":"string","title":"File Name","description":"The name of the extension."},"creation_time":{"type":"integer","title":"Creation Time","description":"The creation timestamp."}},"additionalProperties":true,"type":"object","required":["id","file_name","creation_time"],"title":"Extension","description":"Extension model."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"IAppConnection":{"properties":{"name":{"type":"string","title":"Name","default":""},"description":{"type":"string","title":"Description","default":""},"type":{"type":"string","title":"Type","default":""},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Config"},"protocol":{"$ref":"#/components/schemas/APP_PROTOCOL","default":-1},"status":{"type":"string","title":"Status","default":""}},"type":"object","title":"IAppConnection","description":"App connection model."},"IArtifact":{"properties":{"type":{"type":"string","title":"Type"},"title":{"type":"string","title":"Title","default":""},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"data":{"anyOf":[{},{"type":"null"}],"title":"Data"}},"type":"object","required":["type"],"title":"IArtifact","description":"Artifact model."},"IAutoTopUpCredits":{"properties":{"active":{"type":"boolean","title":"Active"},"amount":{"type":"integer","title":"Amount"},"threshold":{"type":"integer","title":"Threshold"}},"type":"object","required":["active","amount","threshold"],"title":"IAutoTopUpCredits"},"IAutomation":{"properties":{"workspace_id":{"type":"string","title":"Workspace Id","default":""},"id":{"type":"string","title":"Id","default":""},"task_template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Template Id"},"last_run_t":{"type":"integer","title":"Last Run T","default":0},"title":{"type":"string","title":"Title","default":""},"t":{"type":"integer","title":"T","default":0},"type":{"anyOf":[{"$ref":"#/components/schemas/TASK_TYPE"},{"type":"null"}]},"task":{"anyOf":[{"$ref":"#/components/schemas/ITask"},{"type":"null"}]},"webhook_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Id"},"is_active":{"type":"integer","title":"Is Active","default":false},"entity_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Id"},"triggers":{"anyOf":[{"items":{"$ref":"#/components/schemas/ITrigger"},"type":"array"},{"type":"null"}],"title":"Triggers"}},"type":"object","title":"IAutomation","description":"Task template model."},"IBillingFeature":{"properties":{"usage":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Usage"},"included_usage":{"anyOf":[{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},{"type":"string","const":"unlimited"}],"title":"Included Usage"}},"type":"object","title":"IBillingFeature"},"IBillingPlan":{"properties":{"name":{"type":"string","title":"Name"},"id":{"type":"string","title":"Id"},"features":{"additionalProperties":{"$ref":"#/components/schemas/IBillingFeature"},"type":"object","title":"Features"}},"type":"object","required":["name","id"],"title":"IBillingPlan"},"IChat":{"properties":{"workspace_id":{"type":"string","title":"Workspace Id"},"t":{"type":"integer","title":"T"},"id":{"type":"string","title":"Id"},"title":{"type":"string","title":"Title"},"org_h_":{"type":"integer","title":"Org H"},"task_status":{"additionalProperties":{"$ref":"#/components/schemas/TASK_STATUS"},"type":"object","title":"Task Status","default":{}},"task_action":{"additionalProperties":{"type":"string"},"type":"object","title":"Task Action","default":{}},"task_type":{"additionalProperties":{"$ref":"#/components/schemas/TASK_TYPE"},"type":"object","title":"Task Type","default":{}},"task_title":{"additionalProperties":{"type":"string"},"type":"object","title":"Task Title","default":{}},"last_read":{"type":"integer","title":"Last Read","default":0}},"type":"object","required":["workspace_id","t","id","title","org_h_"],"title":"IChat","description":"Chat model."},"IMessage":{"properties":{"chat_id":{"type":"string","title":"Chat Id"},"t":{"type":"integer","title":"T"},"body":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body"},"type":{"type":"string","title":"Type"},"artifacts":{"items":{"$ref":"#/components/schemas/IArtifact"},"type":"array","title":"Artifacts","default":[]},"raw_message":{"anyOf":[{},{"type":"null"}],"title":"Raw Message"}},"type":"object","required":["chat_id","t","type"],"title":"IMessage","description":"Message model."},"IOrganisation":{"properties":{"id":{"type":"string","title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"created_at":{"type":"integer","title":"Created At","default":0},"workspaces":{"additionalProperties":{"type":"string"},"type":"object","title":"Workspaces"},"apps_enabled":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"items":{"type":"string"},"type":"array","uniqueItems":true}],"title":"Apps Enabled"},"credits":{"type":"integer","title":"Credits","default":0},"max_credits":{"type":"integer","title":"Max Credits","default":0},"credit_timestamp":{"type":"integer","title":"Credit Timestamp","default":0},"max_size":{"type":"integer","title":"Max Size"},"invites":{"additionalProperties":{"type":"string"},"type":"object","title":"Invites","default":{}},"members":{"additionalProperties":{"type":"string"},"type":"object","title":"Members","default":{}},"auto_topup_credits":{"type":"boolean","title":"Auto Topup Credits","default":false},"auto_topup_credits_amount":{"type":"integer","title":"Auto Topup Credits Amount","default":0},"auto_topup_credits_threshold":{"type":"integer","title":"Auto Topup Credits Threshold","default":0},"last_auto_topup_credits_timestamp":{"type":"integer","title":"Last Auto Topup Credits Timestamp","default":0}},"type":"object","required":["id","name","workspaces","apps_enabled","max_size"],"title":"IOrganisation","description":"Organisation model."},"ISop":{"properties":{"workspace_id":{"type":"string","title":"Workspace Id","default":""},"timestamp":{"type":"integer","title":"Timestamp","default":0},"title":{"type":"string","title":"Title"},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Purpose"},"procedure":{"type":"string","title":"Procedure"},"apps":{"items":{"type":"string"},"type":"array","title":"Apps","default":[]},"tools":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tools"}},"type":"object","required":["title","purpose","procedure"],"title":"ISop","description":"SOP model."},"ITask":{"properties":{"t":{"type":"integer","title":"T"},"title":{"type":"string","title":"Title"},"body":{"type":"string","title":"Body"},"apps":{"additionalProperties":{"type":"string"},"type":"object","title":"Apps"},"autonomy_level":{"type":"string","title":"Autonomy Level"},"complexity":{"type":"string","title":"Complexity"},"attachments":{"items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array","title":"Attachments"}},"type":"object","required":["title","body","apps","autonomy_level","complexity"],"title":"ITask","description":"Task configuration model."},"ITrigger":{"properties":{"name":{"type":"string","title":"Name","default":""},"description":{"type":"string","title":"Description","default":""},"icon":{"type":"string","title":"Icon","default":""},"schedule_arn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Schedule Arn"},"trigger_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trigger Id"}},"type":"object","title":"ITrigger","description":"Trigger model."},"IWorkspace":{"properties":{"org_h_":{"type":"integer","title":"Org H"},"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"apps":{"additionalProperties":{"$ref":"#/components/schemas/IAppConnection"},"type":"object","title":"Apps"}},"type":"object","required":["org_h_","id","name","apps"],"title":"IWorkspace","description":"Workspace model."},"ListExtensionsResponse":{"properties":{"extensions":{"items":{"$ref":"#/components/schemas/Extension"},"type":"array","title":"Extensions","description":"The list of extensions."}},"additionalProperties":true,"type":"object","required":["extensions"],"title":"ListExtensionsResponse","description":"Response model for listing extensions."},"MessagesResponse":{"properties":{"r":{"items":{"$ref":"#/components/schemas/IMessage"},"type":"array","title":"R"}},"type":"object","required":["r"],"title":"MessagesResponse","description":"Messages response model."},"OrganisationResponse":{"properties":{"apikey":{"type":"string","title":"Apikey"},"organisation":{"$ref":"#/components/schemas/IOrganisation"},"plans":{"additionalProperties":{"$ref":"#/components/schemas/IBillingPlan"},"type":"object","title":"Plans"}},"type":"object","required":["apikey","organisation","plans"],"title":"OrganisationResponse","description":"Organisation response model."},"ProfileRequest":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"The ID to assign to the new profile. If None, a random name will be generated."}},"additionalProperties":true,"type":"object","title":"ProfileRequest","description":"Request model for creating a browser profile."},"ProfileResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the created browser profile."},"cookie_domains":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Cookie Domains","description":"Registered domains (e.g. 'amazon.com') with cookies in this profile, most-recently-accessed first."},"cookie_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cookie Count","description":"Total number of cookies stored in the profile."},"profile_size_bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Profile Size Bytes","description":"Size of the stored profile archive in bytes."},"last_saved_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Last Saved At","description":"Unix epoch seconds of the most recent profile save."}},"additionalProperties":true,"type":"object","required":["id"],"title":"ProfileResponse","description":"Response model for creating a browser profile."},"ProxyResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The name of the proxy, to pass as `proxy_id` when running a task or session."},"type":{"type":"string","title":"Type","description":"The proxy type, e.g. 'isp'."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country the proxy exits from."},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City the proxy exits from."},"exit_ip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exit Ip","description":"IP the proxy's traffic exits from, for whitelisting."},"isp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Isp","description":"ISP owning the exit IP, e.g. 'Lumen'."},"asn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asn","description":"Autonomous system of the exit IP, e.g. 'AS10753'."},"created_at":{"type":"integer","title":"Created At","description":"Unix epoch seconds of when the proxy was created."},"expires_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expires At","description":"Unix epoch seconds of when the current period ends: the renewal date, or the release date if `auto_renew` is False."},"last_used_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Last Used At","description":"Unix epoch seconds of the most recent task using the proxy."},"auto_renew":{"type":"boolean","title":"Auto Renew","description":"Whether the proxy renews automatically at the end of the period."}},"additionalProperties":true,"type":"object","required":["id","type","created_at","auto_renew"],"title":"ProxyResponse","description":"Response model for a Smooth-managed proxy."},"SOPRequest":{"properties":{"title":{"type":"string","title":"Title"},"purpose":{"type":"string","title":"Purpose"},"procedure":{"type":"string","title":"Procedure"},"apps":{"items":{"type":"string"},"type":"array","title":"Apps"}},"type":"object","required":["title","purpose","procedure","apps"],"title":"SOPRequest","description":"SOP request model."},"SOPResponse":{"properties":{"r":{"items":{"$ref":"#/components/schemas/ISop"},"type":"array","title":"R"}},"type":"object","required":["r"],"title":"SOPResponse","description":"SOPs response model."},"TASK_STATUS":{"type":"integer","enum":[0,1,2,3,4,5,6,7],"title":"TASK_STATUS","description":"Task status types."},"TASK_TYPE":{"type":"string","enum":["discovery","automation","task"],"title":"TASK_TYPE","description":"Task types."},"TRIGGER_TYPE":{"type":"string","enum":["cron","composio"],"title":"TRIGGER_TYPE","description":"Trigger types."},"TaskApiResponse_AppConnectionResponse_":{"properties":{"tid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tid"},"r":{"$ref":"#/components/schemas/AppConnectionResponse"}},"type":"object","required":["r"],"title":"TaskApiResponse[AppConnectionResponse]"},"TaskEvent":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the event."},"payload":{"additionalProperties":true,"type":"object","title":"Payload","description":"The payload of the event."},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"The ID of the event."},"timestamp":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timestamp","description":"The timestamp of the event."}},"type":"object","required":["name","payload"],"title":"TaskEvent","description":"Task event model."},"TaskEventResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the event."}},"type":"object","required":["id"],"title":"TaskEventResponse","description":"Task event response model."},"TaskRequest":{"properties":{"task":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task","description":"The task to run. If None, opens a blank browser and waits for further instructions."},"response_model":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Response Model","description":"If provided, the JSON schema describing the desired output structure. Default is None"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"The starting URL for the task. If not provided, the agent will infer it from the task."},"metadata":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}]},"type":"object"},{"type":"null"}],"title":"Metadata","description":"A dictionary containing variables or parameters that will be passed to the agent."},"files":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Files","description":"A list of file ids to pass to the agent."},"agent":{"type":"string","title":"Agent","description":"The agent to use for the task. Default is 'smooth'.","default":"smooth"},"max_steps":{"type":"integer","maximum":128.0,"minimum":2.0,"title":"Max Steps","description":"Maximum number of steps the agent can take (min 2, max 128).","default":32},"device":{"type":"string","enum":["desktop","mobile","desktop-lg"],"title":"Device","description":"Device type for the task. Default is desktop.","default":"desktop"},"allowed_urls":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Allowed Urls","description":"List of allowed URL patterns using wildcard syntax (e.g., https://*example.com/*). If None, all URLs are allowed."},"enable_recording":{"type":"boolean","title":"Enable Recording","description":"Enable video recording of the task execution. Default is True","default":true},"profile_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Id","description":"Browser profile ID to use. Each profile maintains its own state, such as cookies and login credentials."},"profile_read_only":{"type":"boolean","title":"Profile Read Only","description":"If true, the profile specified by `profile_id` will be loaded in read-only mode. Changes made during the task will not be saved back to the profile.","default":false},"stealth_mode":{"type":"boolean","title":"Stealth Mode","description":"(Deprecated, ignored) Use `use_stealth` instead. Stealth is on by default.","default":false,"deprecated":true},"use_stealth":{"type":"boolean","title":"Use Stealth","description":"Run the browser in stealth mode. Default is True.","default":true},"proxy_server":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy Server","description":"Proxy server url to route browser traffic through."},"proxy_username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy Username","description":"Proxy server username."},"proxy_password":{"anyOf":[{"type":"string","format":"password","writeOnly":true},{"type":"null"}],"title":"Proxy Password","description":"Proxy server password."},"proxy_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy Id","description":"Name of a Smooth-managed proxy to route browser traffic through, as returned by `list_proxies()`. Cannot be combined with `proxy_server`."},"certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/Certificate"},"type":"array"},{"type":"null"}],"title":"Certificates","description":"List of client certificates to use when accessing secure websites. Each certificate is a dictionary with the following fields:\n - `file`: p12 file object to be uploaded (e.g., open('cert.p12', 'rb')).\n - `password` (optional): Password to decrypt the certificate file."},"use_adblock":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Use Adblock","description":"Enable adblock for the browser session. Default is True.","default":true},"use_captcha_solver":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Use Captcha Solver","description":"Enable captcha solver for the browser session. Default is True.","default":true},"additional_tools":{"anyOf":[{"additionalProperties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Additional Tools","description":"Additional tools to enable for the task."},"custom_tools":{"anyOf":[{"items":{"$ref":"#/components/schemas/ToolSignature"},"type":"array"},{"type":"null"}],"title":"Custom Tools","description":"Custom tools to register for the task."},"experimental_features":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Experimental Features","description":"Experimental features to enable for the task."},"extensions":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Extensions","description":"List of extensions to install for the task."},"show_cursor":{"type":"boolean","title":"Show Cursor","description":"Show mouse cursor. Default is False.","default":false},"cursor_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor Text","description":"Custom text shown in the cursor label bubble (max 16 characters). Requires show_cursor=True and a Growth plan."},"cursor_bubble_color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor Bubble Color","description":"Custom hex color (e.g. '#0081ff') for the cursor label bubble. Requires show_cursor=True and a Growth plan."},"idle_timeout":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Idle Timeout","description":"Seconds of inactivity (no task, goto, evaluate_js, or extract) after which an open session auto-closes. Only applies to sessions (task is None). None uses the server default (5 minutes); 0 or negative disables auto-close."}},"additionalProperties":true,"type":"object","title":"TaskRequest","description":"Run task request model."},"TaskResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the task."},"status":{"type":"string","enum":["waiting","running","done","failed","cancelled"],"title":"Status","description":"The status of the task."},"output":{"anyOf":[{},{"type":"null"}],"title":"Output","description":"The output of the task."},"credits_used":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Used","description":"The amount of credits used to perform the task."},"device":{"anyOf":[{"type":"string","enum":["desktop","mobile","desktop-lg"]},{"type":"null"}],"title":"Device","description":"The device type used for the task."},"live_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Live Url","description":"The URL to view and interact with the task execution."},"recording_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recording Url","description":"The URL to view the task recording."},"downloads_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Downloads Url","description":"The URL of the archive containing the downloaded files."},"network_har_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Network Har Url","description":"Presigned URL of the network HAR (gzipped) capturing the task's network activity."},"console_log_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Console Log Url","description":"Presigned URL of the timestamped browser console log."},"session_log":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Session Log","description":"Timestamped log of the session's steps and actions."},"created_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Created At","description":"The timestamp when the task was created."},"tool_calls":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/ToolCall"},"type":"object"},{"type":"null"}],"title":"Tool Calls","description":"Contains a list of pending tool calls.","deprecated":true},"events":{"anyOf":[{"items":{"$ref":"#/components/schemas/TaskEvent"},"type":"array"},{"type":"null"}],"title":"Events","description":"The list of new events fired."}},"additionalProperties":true,"type":"object","required":["id","status"],"title":"TaskResponse","description":"Task response model."},"TaskResponsePlusInternals":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the task."},"status":{"type":"string","enum":["waiting","running","done","failed","cancelled"],"title":"Status","description":"The status of the task."},"output":{"anyOf":[{},{"type":"null"}],"title":"Output","description":"The output of the task."},"credits_used":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Used","description":"The amount of credits used to perform the task."},"device":{"anyOf":[{"type":"string","enum":["desktop","mobile","desktop-lg"]},{"type":"null"}],"title":"Device","description":"The device type used for the task."},"live_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Live Url","description":"The URL to view and interact with the task execution."},"recording_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recording Url","description":"The URL to view the task recording."},"downloads_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Downloads Url","description":"The URL of the archive containing the downloaded files."},"network_har_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Network Har Url"},"console_log_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Console Log Url"},"session_log":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Session Log"},"created_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Created At","description":"The timestamp when the task was created."},"tool_calls":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/ToolCall"},"type":"object"},{"type":"null"}],"title":"Tool Calls","description":"Contains a list of pending tool calls.","deprecated":true},"events":{"anyOf":[{"items":{"$ref":"#/components/schemas/TaskEvent"},"type":"array"},{"type":"null"}],"title":"Events","description":"The list of new events fired."},"exec_trace_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exec Trace Url"},"d":{"title":"D"},"fingerprint_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fingerprint Id"}},"additionalProperties":true,"type":"object","required":["id","status"],"title":"TaskResponsePlusInternals","description":"Add on anything we don't want to support in the public SDK."},"TaskUpdateRequest":{"properties":{"tool_response":{"anyOf":[{"$ref":"#/components/schemas/ToolCallResponse"},{"type":"null"}],"description":"The tool response to the agent query."}},"additionalProperties":true,"type":"object","title":"TaskUpdateRequest","description":"Update task request model."},"TelemetryEvent":{"properties":{"event":{"type":"string","title":"Event"},"timestamp":{"type":"string","title":"Timestamp"},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties"}},"type":"object","required":["event","timestamp"],"title":"TelemetryEvent","description":"A single telemetry event from the SDK/CLI."},"TelemetryRequest":{"properties":{"events":{"items":{"$ref":"#/components/schemas/TelemetryEvent"},"type":"array","title":"Events"}},"type":"object","required":["events"],"title":"TelemetryRequest","description":"Batched telemetry events from the SDK/CLI."},"ToolCall":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the tool being called."},"input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input","description":"The input provided to the tool (json encoded)."},"code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Code","description":"The tool call returned HTTP status code."},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output","description":"The output produced by the tool (json encoded)."}},"additionalProperties":true,"type":"object","title":"ToolCall","description":"Tool call model."},"ToolCallResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the tool call."},"code":{"type":"integer","title":"Code","description":"The HTTP status code of the tool call."},"output":{"type":"string","title":"Output","description":"The output produced by the tool (json encoded)."}},"additionalProperties":true,"type":"object","required":["id","code","output"],"title":"ToolCallResponse","description":"Tool call response model."},"ToolResponse":{"properties":{"r":{"title":"R"}},"type":"object","required":["r"],"title":"ToolResponse","description":"Tool response model."},"ToolSignature":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the tool."},"description":{"type":"string","title":"Description","description":"A brief description of the tool."},"inputs":{"additionalProperties":true,"type":"object","title":"Inputs","description":"The input parameters for the tool."},"output":{"type":"string","title":"Output","description":"The output produced by the tool."}},"type":"object","required":["name","description","inputs","output"],"title":"ToolSignature","description":"Tool signature model."},"UpdateAttachmentRequest":{"properties":{"title":{"type":"string","title":"Title"},"type":{"type":"string","title":"Type"},"data":{"type":"string","title":"Data"}},"type":"object","required":["title","type","data"],"title":"UpdateAttachmentRequest","description":"Update attachment request model."},"UploadExtensionResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The uploaded extension ID."}},"additionalProperties":true,"type":"object","required":["id"],"title":"UploadExtensionResponse","description":"Response model for uploading an extension."},"UploadFileResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The ID assigned to the uploaded file."}},"additionalProperties":true,"type":"object","required":["id"],"title":"UploadFileResponse","description":"Response model for uploading a file."},"UsageResponse":{"properties":{"api_credits":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Api Credits","description":"Remaining API credit balance"},"api_browser_sessions":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Api Browser Sessions","description":"Remaining browser session balance"},"plan":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan","description":"Current API plan name"}},"type":"object","title":"UsageResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WorkspaceResponse":{"properties":{"r":{"$ref":"#/components/schemas/IWorkspace"}},"type":"object","required":["r"],"title":"WorkspaceResponse","description":"Workspaces response model."}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"apikey"}}}}